DocumentationAPI Reference
General reference, eKYB Reference / eKYB Prefill Coverage

Saudi Arabia

eKYB Prefill in Saudi Arabia leverages official Saudi business registry data to automatically retrieve and populate business information based on a company's registration number, including the business name, registration status, entity type, registration date, incorporation date, and registered address, without requiring manual input from the user.

Source

Source Description
SA_KYB_PREFILL Returns matching Saudi Arabia business details from official business registry data for prefill.

Direct API approach

For general integration notes and shared response semantics, see the eKYB Prefill API Reference.

Endpoint

POST /omni/externalVerification/ekyb-prefill

Request parameters

Parameter Required Description
plugins Mandatory String array. Must be ["ekyb-prefill"]. Specifies the Prefill flow.
source Mandatory String. Must be SA_KYB_PREFILL. Identifies the Prefill source.
country Mandatory String. Two-letter Alpha-2 country code. Must be SA.
taxId Mandatory String. Saudi Commercial Registration (CR) number. Must be a 10-digit numeric value. See Tax ID formats for details.
businessName Optional String. Registered name of the business. When provided, may improve match accuracy.

Tax ID formats

For businesses, the following identifier types are supported, all as 10-digit numeric values:

Format Example
Commercial Registration (CR) number 1010223344
License number 2050112233
Tax number 3001998877

For individuals, the supported identifier is:

Format Example
National ID number 1098765432

Note

The Saudi Commercial Registration (CR) number must be a 10-digit numeric value (regex: ^\d{10}$). Requests with a taxId that does not match this format will be rejected. Business name and address data may be returned in Arabic script.

Sample request

{
    "plugins": ["ekyb-prefill"],
    "source": "SA_KYB_PREFILL",
    "country": "SA",
    "taxId": "1010223344",
    "businessName": "Al Noor Trading Company"
}

Sample response

The Prefill response returns business data retrieved directly from the source of truth. Fields are returned as-is from the source.

{
  "kyb-prefill": [
    {
      "tin": "1010223344",
      "name": "AL NOOR TRADING COMPANY",
      "registrationStatus": "Active",
      "entityType": "Unknown",
      "registrationDate": "2019-03-11",
      "incorporationDate": "2005-07-02",
      "address": "RIYADH, AL OLAYA DISTRICT, RIYADH, SA-01, SAUDI ARABIA, 12212",
      "email": null,
      "phoneNumber": null
    }
  ]
}

Response fields

Key Value Description
tin Registration number The Saudi CR/tax/license number as submitted in the request, confirmed by the source of truth.
name Business name The registered legal name of the business as returned from the source of truth. Names originally in Arabic are automatically translated to English.
registrationStatus Active, Inactive, Unknown Current registration status of the business. See Registration status values for details.
entityType Entity type The legal entity type of the business as returned from the source of truth. Returns Unknown when not available.
registrationDate Date The date the company was registered in the source registry, as returned from the source of truth. May not be present for all companies.
incorporationDate Date The date the company was incorporated, as returned from the source of truth. Falls back to an alternate source field when the primary field is not available. May not be present for all companies.
address Registered address The primary registered address of the business as returned from the source of truth. Addresses originally in Arabic are automatically translated to English. May not be present for all companies.
email Email address The business contact email address registered with the source of truth, if available.
phoneNumber Phone number The business contact phone number registered with the source of truth, if available.

Registration status values

Status Description
Active The company is currently active and registered.
Inactive The company registration is dissolved or inactive.
Unknown The registration status could not be determined.

Error responses

For standard HTTP response codes, see the API Error Response page. Saudi Arabia Prefill returns the following country-specific 400 errors.

taxId is missing, empty, or does not match the required 10-digit format:

{
    "timestamp": 1782851408892,
    "status": 400,
    "error": "Bad Request",
    "message": "must not be blank",
    "path": "/omni/externalVerification/ekyb-prefill"
}

Any mandatory field (plugins, source, or country) is missing:

{
    "timestamp": 1782851468367,
    "status": 400,
    "error": "Bad Request",
    "message": "must not be blank",
    "path": "/omni/externalVerification/ekyb-prefill"
}

No business match is found for the submitted taxId:

{
    "timestamp": 1782851583695,
    "status": 200,
    "message": "No business found matching the provided tax ID.",
    "path": "/omni/externalVerification/ekyb-prefill"
}

Single Session Dashboard results

Prefill results are available on the Business tab in single Session view.

Was this page helpful?