🛂#6 Passport Scan

#6.1 Select National Id Step (False) :

This API is only required when 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

#6.2 Upload Passport Image :

This API is to upload passport 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

400

BadRequest

application/json

401

Unauthorized

application/json

post

/Onboarding/api/v1/onboarding/Passport/UploadPassportImage

HTTPcURLJavaScriptPython

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

{
  "image": "text"
}

{
  "isSuccess": true,
  "message": "text",
  "errorCode": "text",
  "passportData": {
    "customerId": "text",
    "firstNameEn": "text",
    "familyNameEn": "text",
    "fullNameEn": "text",
    "fullNameAr": "text",
    "firstNameAr": "text",
    "familyNameAr": "text",
    "birthdate": "2025-12-24T12:05:08.249Z",
    "expirationDate": "2025-12-24T12:05:08.249Z",
    "gender": "text",
    "documentNumber": "text",
    "documentCode": "text",
    "issuingAuthority": "text",
    "nationality": "text",
    "visualZone": "text",
    "photo": "text"
  }
}

#6.3 Approve Passport Info:

This API is to approve the OCR result data of passport image.

post

Authorizations

JWT

AuthorizationstringRequired

Please insert JWT with Bearer into field

Body

application/json

fullNameArstring | nullableOptional

Translated arabic full name, this attribute can be used when traslate feature is enabled at admin panel configuration steps.

Example: أحمد محمد أحمد محمد

Responses

200

Success

application/json

401

Unauthorized

application/json

404

NotFound

application/json

post

/Onboarding/api/v1/onboarding/Passport/Approve

HTTPcURLJavaScriptPython

POST /Onboarding/api/v1/onboarding/Passport/Approve HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 52

{
  "fullNameAr": "أحمد محمد أحمد محمد"
}

{
  "status": 0
}