POST
Create Identity

Authorizations

x-api-key
string
header
required

Headers

x-tenant
string
required

Tenant identifier

Path Parameters

entityId
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

data
object | null
required
creationStatus
enum<string>
Available options:
Created,
Invalid,
Existing