💳#5 National Id Scan

#5.1 Select National Id Step (True) :

This API is only required when national id or passport configuration is enabled .

post
Authorizations
Path parameters
isNationalIDbooleanRequired
Header parameters
Accept-LanguageStringOptional
AuthorizationstringOptional

ex: Bearer

Responses
200
Success
post
POST /api/v1/onboarding/Request/SelectNationalIdStep/{isNationalID} HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

No content

#5.2 Upload National Id Front Image :

post
Authorizations
Header parameters
Accept-LanguageStringOptional
AuthorizationstringOptional

ex: Bearer

Body
customerIdstring | nullableOptional
imagestring | nullableOptional
Responses
200
Success
post
POST /api/v1/onboarding/NationalId/UploadFrontImage HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 36

{
  "customerId": "text",
  "image": "text"
}
{
  "isSuccess": true,
  "message": "text",
  "customerData": {
    "customerId": "text",
    "idFrontScan": "text",
    "idBackScan": "text",
    "photo": "text",
    "fullName": "text",
    "fullNameEn": "text",
    "firstName": "text",
    "firstNameEn": "text",
    "familyName": "text",
    "familyNameEn": "text",
    "address": "text",
    "state": "text",
    "birthdate": "2025-06-30T16:57:36.462Z",
    "idNumber": "text",
    "idNumberBack": "text",
    "documentNumber": "text",
    "documentTypeId": "text",
    "documentTypeCode": "text",
    "issueDate": "2025-06-30T16:57:36.462Z",
    "profession": "text",
    "maritalStatus": "text",
    "religion": "text",
    "gender": "text",
    "nationality": "text",
    "detectedAge": 1,
    "detectedGender": "text",
    "expirationDate": "2025-06-30T16:57:36.462Z"
  }
}

#5.3 Upload National Id Back Image :

post
Authorizations
Header parameters
Accept-LanguageStringOptional
AuthorizationstringOptional

ex: Bearer

Body
customerIdstring | nullableOptional
imagestring | nullableOptional
Responses
200
Success
post
POST /api/v1/onboarding/NationalId/UploadBackImage HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 36

{
  "customerId": "text",
  "image": "text"
}
{
  "isSuccess": true,
  "message": "text",
  "customerData": {
    "customerId": "text",
    "idFrontScan": "text",
    "idBackScan": "text",
    "photo": "text",
    "fullName": "text",
    "fullNameEn": "text",
    "firstName": "text",
    "firstNameEn": "text",
    "familyName": "text",
    "familyNameEn": "text",
    "address": "text",
    "state": "text",
    "birthdate": "2025-06-30T16:57:36.462Z",
    "idNumber": "text",
    "idNumberBack": "text",
    "documentNumber": "text",
    "documentTypeId": "text",
    "documentTypeCode": "text",
    "issueDate": "2025-06-30T16:57:36.462Z",
    "profession": "text",
    "maritalStatus": "text",
    "religion": "text",
    "gender": "text",
    "nationality": "text",
    "detectedAge": 1,
    "detectedGender": "text",
    "expirationDate": "2025-06-30T16:57:36.462Z"
  }
}

#5.4 Approve National Id Front Image :

post
Authorizations
Header parameters
Accept-LanguageStringOptional
AuthorizationstringOptional

ex: Bearer

Body
fullNameEnstring | nullableOptional
firstNameEnstring | nullableOptional
familyNameEnstring | nullableOptional
Responses
200
Success
Responseboolean
post
POST /api/v1/onboarding/NationalId/ApproveFrontImage HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 64

{
  "fullNameEn": "text",
  "firstNameEn": "text",
  "familyNameEn": "text"
}
true

#5.5 Approve National Id Back Image :

post
Authorizations
Header parameters
Accept-LanguageStringOptional
AuthorizationstringOptional

ex: Bearer

Responses
200
Success
Responseboolean
post
POST /api/v1/onboarding/NationalId/ApproveBackImage HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

true
Previous#4 Get LocationNext#6 Passport Scan

Last updated