PATCH
Update Identity

Authorizations

x-api-key
string
header
required

Headers

x-tenant
string
required

Tenant identifier

Path Parameters

identityId
string
required

Body

application/json
type
enum<string>
required

Type of identity document

Available options:
NationalIdentity,
ResidencyPermit,
CommercialRegistration,
UnifiedNumber,
Passport,
GccCompany,
NonProfit,
Waqf,
LicenseNumber,
DrivingLicense,
DigitalId,
Other
number
string
required

Identity document number

Example:

"A123456789"

subtype
string

Identity document subtype

expiresAt
string<date-time>

ID expiration date (YYYY-MM-DD)

Example:

"2030-12-31"

issuingCountryCode
string

Issuing country code (ISO 3166-1 alpha-2)

Example:

"SA"

documentIds
string[]

Attachment IDs of supporting ID documents (e.g. scanned ID front/back, passport). At least one is required.

Response

Success

id
string
required

Dal's database Id

Example:

"b50c7893-cd88-42bd-9fdd-b94f493315f9"

createdAt
string<date-time>
required

Create timestamp

Example:

"2025-12-02 12:00:00.000"

updatedAt
string<date-time>
required

Update timestamp

Example:

"2025-12-04 12:00:00.000"

verifiedAt
string<date-time> | null
required

ID verification date (YYYY-MM-DD)

Example:

"2024-06-18"

expiresAt
string<date-time> | null
required

ID expiration date (YYYY-MM-DD)

Example:

"2030-12-31"

type
enum<string>
required

Type of identity document

Available options:
NationalIdentity,
ResidencyPermit,
None,
CommercialRegistration,
UnifiedNumber,
Passport,
GccCompany,
NonProfit,
Waqf,
LicenseNumber,
DrivingLicense,
DigitalId,
Other
Example:

"Passport"

subtype
object | null
required

The ID subtype as extracted from international verification (e.g. "UAE Driving License").

Example:

"Iqama"

number
string
required

Identity document number

Example:

"A123456789"

issuingCountryCode
object | null

ID issuing country two-letter code

Example:

"SA"

selfie
object | null

ID selfie image

documents
object[]

ID documents

verification
object | null

Verification linked to this ID (pending manual proposal or completed attempt)