💳# 1 National Id

it will be your First step and you can chose to upload image or capture your id. you should start with front of Id then back following these APIs.

Upload Front Image

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

isSuccessbooleanOptional

messagestring · nullableOptional

errorCodestring · nullableOptional

400

BadRequest

application/json

401

Unauthorized

application/json

404

NotFound

application/json

post

/Onboarding/api/v1/onboarding/NationalIdKyc/UploadFrontImage

HTTPcURLJavaScriptPython

POST /Onboarding/api/v1/onboarding/NationalIdKyc/UploadFrontImage HTTP/1.1
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": "2026-03-21T02:14:56.425Z",
    "idNumber": "text",
    "idNumberBack": "text",
    "documentNumber": "text",
    "documentTypeId": "text",
    "documentTypeCode": "text",
    "issueDate": "2026-03-21T02:14:56.425Z",
    "profession": "text",
    "maritalStatus": "text",
    "religion": "text",
    "gender": "text",
    "nationality": "text",
    "detectedAge": 1,
    "detectedGender": "text",
    "expirationDate": "2026-03-21T02:14:56.425Z"
  }
}

Upload Back Image

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

isSuccessbooleanOptional

messagestring · nullableOptional

errorCodestring · nullableOptional

400

BadRequest

application/json

401

Unauthorized

application/json

404

NotFound

application/json

post

/Onboarding/api/v1/onboarding/NationalIdKyc/UploadBackImage

HTTPcURLJavaScriptPython

POST /Onboarding/api/v1/onboarding/NationalIdKyc/UploadBackImage HTTP/1.1
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": "2026-03-21T02:14:56.425Z",
    "idNumber": "text",
    "idNumberBack": "text",
    "documentNumber": "text",
    "documentTypeId": "text",
    "documentTypeCode": "text",
    "issueDate": "2026-03-21T02:14:56.425Z",
    "profession": "text",
    "maritalStatus": "text",
    "religion": "text",
    "gender": "text",
    "nationality": "text",
    "detectedAge": 1,
    "detectedGender": "text",
    "expirationDate": "2026-03-21T02:14:56.425Z"
  }
}

Approve front image

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

fullNamestring · 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

idNumberstring · nullableOptional

Client National Id Number and it contains from 14 digit.

Example: 29874532145698

documentNumberstring · nullableOptional

Client Factory Number that taken From National Id

Example: Gm2134524

addressstring · nullableOptional

Client Address From National Id

Example: 15 st elgnainy

statestring · nullableOptional

the second Part Of Address.

Example: hadaek el koba - Cairo

birthdatestring · nullableOptional

Client Date of Birth that took from National Id

Example: 19/09/1998

Responses

200

Success

application/json

booleanOptional

400

BadRequest

application/json

401

Unauthorized

application/json

404

NotFound

application/json

post

/Onboarding/api/v1/onboarding/NationalIdKyc/ApproveFrontImage

HTTPcURLJavaScriptPython

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

{
  "fullNameEn": "Ahmed Mohamed Ali",
  "firstNameEn": "Ahmed",
  "familyNameEn": "Mohamed Ali",
  "fullName": "Ahmed Mohamed Ali",
  "idNumber": "29874532145698",
  "documentNumber": "Gm2134524",
  "address": "15 st elgnainy",
  "state": "hadaek el koba - Cairo",
  "birthdate": "19/09/1998"
}

true

Approve Back Image

post

Authorizations

JWT

AuthorizationstringRequired

Please insert JWT with Bearer into field

Responses

200

Success

application/json

booleanOptional

400

BadRequest

application/json

401

Unauthorized

application/json

404

NotFound

application/json

post

/Onboarding/api/v1/onboarding/NationalIdKyc/ApproveBackImage

HTTPcURLJavaScriptPython

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

true

Set User Onboarding Continuation Permission

This endpoint allows updating the onboarding continuation status for an existing and already onboarded user.

When the user already exists in the system, this API is used to explicitly set whether the user is allowed to continue the onboarding process (true) or not (false).

• true → The user is allowed to continue onboarding.

• false → The user is not allowed to continue onboarding.

⚠️ Important: This endpoint must be called after the Upload Front Image step is successfully completed.

If the business validation fails in Upload Front Image endpoint, the endpoint should return the following error response:

errorCode: "20064"
message: "Natinal Id Already Exist"

The endpoint returns a boolean value indicating whether the operation was successfully completed.

post

Authorizations

JWT

AuthorizationstringRequired

Please insert JWT with Bearer into field

Query parameters

isAllowToContinuebooleanOptional

Header parameters

Accept-LanguagestringOptional

Responses

200

Success

application/json

booleanOptional

post

/Onboarding/api/v1/onboarding/NationalIdKyc/SetIsAllowContinue

HTTPcURLJavaScriptPython

POST /Onboarding/api/v1/onboarding/NationalIdKyc/SetIsAllowContinue HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

200

Success

true