💳#5 National Id Scan

#5.1 Select National Id Step (True) :

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

If you enable the National ID or Passport option in the Personality Confirmation section of the Organization Configuration, then during the onboarding process you must specify the type of document you want to use for onboarding — either National ID or Passport.

post

Authorizations

JWT

AuthorizationstringRequired

Please insert JWT with Bearer into field

Path parameters

isNationalIDbooleanRequired

True if onboarding using National Id, false if passport

Example: true

Responses

200

Success

No content

400

BadRequest

application/json

401

Unauthorized

application/json

post

/Onboarding/api/v1/onboarding/Request/SelectNationalIdStep/{isNationalID}

HTTPcURLJavaScriptPython

POST /Onboarding/api/v1/onboarding/Request/SelectNationalIdStep/{isNationalID} HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

No content

#5.2 Upload National Id Front Image :

This API is to upload front-side image of National Id.

post

Authorizations

JWT

AuthorizationstringRequired

Please insert JWT with Bearer into field

Body

application/json

imagestringRequired

This attribute is base64 front-side, back-side or passport image.

Responses

200

Success

application/json

400

BadRequest

application/json

401

Unauthorized

application/json

post

/Onboarding/api/v1/onboarding/NationalId/UploadFrontImage

HTTPcURLJavaScriptPython

POST /Onboarding/api/v1/onboarding/NationalId/UploadFrontImage HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 16

{
  "image": "text"
}

{
  "isSuccess": true,
  "message": "text",
  "errorCode": "text",
  "customerData": {
    "customerId": "A9C3E5D7-4B2F-47AC-9D61-3F1B1A1E87C6",
    "idFrontScan": "XXXXXXXXXXXXXX(14 digits)",
    "idBackScan": "XXXXXXXXXXXXXX(14 digits)",
    "photo": "string path",
    "fullName": "text",
    "fullNameEn": "text",
    "firstName": "text",
    "firstNameEn": "text",
    "familyName": "text",
    "familyNameEn": "text",
    "address": "text",
    "state": "text",
    "birthdate": "2025-12-11T10:18:54.672Z",
    "idNumber": "text",
    "idNumberBack": "text",
    "documentNumber": "text",
    "documentTypeId": "text",
    "documentTypeCode": "text",
    "issueDate": "2025-12-11T10:18:54.672Z",
    "profession": "text",
    "maritalStatus": "text",
    "religion": "text",
    "gender": "text",
    "nationality": "text",
    "detectedAge": 1,
    "detectedGender": "text",
    "expirationDate": "2025-12-11T10:18:54.672Z"
  }
}

#5.3 Upload National Id Back Image :

This API is to upload back-side image of National Id.

post

Authorizations

JWT

AuthorizationstringRequired

Please insert JWT with Bearer into field

Body

application/json

imagestringRequired

This attribute is base64 front-side, back-side or passport image.

Responses

200

Success

application/json

400

BadRequest

application/json

401

Unauthorized

application/json

post

/Onboarding/api/v1/onboarding/NationalId/UploadBackImage

HTTPcURLJavaScriptPython

POST /Onboarding/api/v1/onboarding/NationalId/UploadBackImage HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 16

{
  "image": "text"
}

{
  "isSuccess": true,
  "message": "text",
  "errorCode": "text",
  "customerData": {
    "customerId": "A9C3E5D7-4B2F-47AC-9D61-3F1B1A1E87C6",
    "idFrontScan": "XXXXXXXXXXXXXX(14 digits)",
    "idBackScan": "XXXXXXXXXXXXXX(14 digits)",
    "photo": "string path",
    "fullName": "text",
    "fullNameEn": "text",
    "firstName": "text",
    "firstNameEn": "text",
    "familyName": "text",
    "familyNameEn": "text",
    "address": "text",
    "state": "text",
    "birthdate": "2025-12-11T10:18:54.672Z",
    "idNumber": "text",
    "idNumberBack": "text",
    "documentNumber": "text",
    "documentTypeId": "text",
    "documentTypeCode": "text",
    "issueDate": "2025-12-11T10:18:54.672Z",
    "profession": "text",
    "maritalStatus": "text",
    "religion": "text",
    "gender": "text",
    "nationality": "text",
    "detectedAge": 1,
    "detectedGender": "text",
    "expirationDate": "2025-12-11T10:18:54.672Z"
  }
}

#5.4 Approve National Id Front Image :

This API is to approve the OCR result data of front-side National Id.

post

Authorizations

JWT

AuthorizationstringRequired

Please insert JWT with Bearer into field

Body

application/json

fullNameEnstring | nullableOptional

Client english full name. Attribute is used when translation feature was enabled from admin panel configuration. If the english full name has no changes you can pass the same value of OCR translated result. It is mandatory if trasnslate feature was enabled.

Example: Ahmed Mohamed Ali

firstNameEnstring | nullableOptional

Client english first name. Attribute is used when translation feature was enabled from admin panel configuration. If the english first name has no changes you can pass the same value of OCR translated result. It is mandatory if trasnslate feature was enabled.

Example: Ahmed

familyNameEnstring | nullableOptional

Client english family name. Attribute is used when translation feature was enabled from admin panel configuration. If the english family name has no changes you can pass the same value of OCR translated result. It is mandatory if trasnslate feature was enabled.

Example: Mohamed Ali

Responses

200

Success

application/json

Responseboolean

400

BadRequest

application/json

401

Unauthorized

application/json

post

/Onboarding/api/v1/onboarding/NationalId/ApproveFrontImage

HTTPcURLJavaScriptPython

POST /Onboarding/api/v1/onboarding/NationalId/ApproveFrontImage HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 85

{
  "fullNameEn": "Ahmed Mohamed Ali",
  "firstNameEn": "Ahmed",
  "familyNameEn": "Mohamed Ali"
}

true

#5.5 Approve National Id Back Image :

This API is to approve the OCR result data of back-side National Id.

post

Authorizations

JWT

AuthorizationstringRequired

Please insert JWT with Bearer into field

Responses

200

Success

application/json

Responseboolean

400

BadRequest

application/json

401

Unauthorized

application/json

post

/Onboarding/api/v1/onboarding/NationalId/ApproveBackImage

HTTPcURLJavaScriptPython

POST /Onboarding/api/v1/onboarding/NationalId/ApproveBackImage HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

true