June 01, 2026

This release introduces the following enhancements:

Entity categorization, enabling entities to be classified as clients, screening entities, prospects, or associations.
Simplified entity names through unified Arabic and English name fields.
Support for multiple identities per entity.
Globally applicable identity types, replacing Saudi-specific and GCC-specific identity concepts.
Support for multiple submissions for KYC/KYB forms.

All deprecated fields and compatibility behaviors will be permanently removed after July 19, 2026.

API Routes

This table shows how routes with the clients prefix are replaced with the entities prefix as part of the new entity categorization.

Module	Deprecated Route Prefix	Migrate To
Client entities	`clients/..`	`entities/client/..`
Screening entities	`clients/screening/..`	`entities/screening/..`
Prospect entities	`clients/onboarding/..`	`entities/prospect/..`
KYC, bank accounts, addresses, and identity verifications	`clients/{clientId}/..`	`entities/{entityId}/..`

API Parameters

The following table summarizes the deprecated request and response parameters and their corresponding replacements across all related routes.

Routes	Location	Deprecated Fields	Migrate To
Entity routes	Request & response bodies	`firstNameEn`, `middleNameEn`, `lastNameEn`	`nameEn`
Entity routes	Request & response bodies	`firstNameAr`, `middleNameAr`, `lastNameAr`	`nameAr`
Entity routes	Request & response bodies	`idType`, `idNumber`, `unifiedNumber`, `idExpirationDate`, `idIssuingCountryCode`	`identities[]` in details here
KYC routes	Response body	`submission`	`submissions[]`
Create screening route	Request	`allowAutoOnboarding` in body params	`allowAutoOnboarding` in query params
All creation routes	Response body	`created`	`creationStatus`
Entity creation routes	Response body	`client`	`data`

Multiple Identities

The unifiedNumber field has been removed. Instead, unified numbers are represented as a separate identity object where type is UnifiedNumber.

Before
After

{
  "type": "Organization",
  "category": "Client",
  "nameEn": "XYZ Company",
  // other props..

  "idType": "CommercialRegistration",
  "idNumber": "4030160464",
  "unifiedNumber": "7012574021",
  "idExpirationDate": "2030-06-01",
  "idIssuingCountryCode": "SA"
}

{
  "type": "Organization",
  "category": "Client",
  "nameEn": "XYZ Company",
  // other props..

  "identities": [
    {
      "type": "CommercialRegistration",
      "number": "4030160464",
      "expiresAt": "2030-06-01",
      "issuingCountryCode": "SA"
    },
    {
      "type": "UnifiedNumber",
      "number": "7012574021",
      "expiresAt": null,
      "issuingCountryCode": "SA"
    }
  ]
}

Deprecated Identity Types

The following identity types are deprecated and are retained temporarily for backward compatibility. Clients should migrate to the new identity types and provide an appropriate issuingCountryCode.

Deprecated Type	Migrate To	`issuingCountryCode`
`Iqama`	`ResidencyPermit`	`SA`
`Gcc`	`NationalIdentity`	One of: `AE`, `QA`, `KW`, `BH`, `OM`

Identity Number Validation

Within each identity object, only type and number are required fields. All other fields are optional. However, issuingCountryCode is strongly recommended and should be provided whenever available to enable better validation and consistency.

Type	Issuing Country	Number Pattern
`NationalIdentity`	`SA`	`^1\d{9}$`
`ResidencyPermit`	`SA`	`^2\d{9}$`
`CommercialRegistration`	`SA`	`^\d+$`
`UnifiedNumber`	`SA`	`^7\d{9}$`
`NationalIdentity`	`AE`	`^784\d{12}$`
`NationalIdentity`	`QA`	`^[23]\d{10}$`
`NationalIdentity`	`KW`	`^[12]\d{11}$`
`NationalIdentity`	`BH`	`^\d{9}$`
`NationalIdentity`	`OM`	`^\d{8}$`

Getting Started

Integration

Transaction Monitoring

Breaking Changes

API Routes

API Parameters

Multiple Identities

Deprecated Identity Types

Identity Number Validation

​API Routes

​API Parameters

​Multiple Identities

​Deprecated Identity Types

​Identity Number Validation

API Routes

API Parameters

Multiple Identities

Deprecated Identity Types

Identity Number Validation