POST
Save provider response

Authorizations

x-api-key
string
header
required

Headers

x-tenant
string
required

Tenant identifier

Body

application/json
provider
enum<string>
required

Provider that produced the response

Available options:
Wathq
type
enum<string>
required

Identity type of the number the response describes

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

Identity number the response describes. Dal uses the response when it next verifies the entity holding this identity

Example:

"7001234567"

rawResponse
object
required

The provider response as received. For Wathq, the commercial registration fullinfo response from your own Wathq subscription

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"

provider
enum<string>
required

Provider that produced the response

Available options:
Wathq,
Sigma,
Yakeen,
IdWise
rawResponse
string
required

JSON-stringified raw provider response. Parse on the entity.

number
object | null

Identity number the response describes

Example:

"7001234567"

type
enum<string> | null

Identity type of that number

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