🛂#6 Passport Scan

#6.1 Select National Id Step (False) :

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

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

Path parameters

isNationalID*boolean

Header parameters

Response

200400

Success

Request

JavaScriptCurlPythonHTTP

const response = await fetch('/api/v1/onboarding/Request/SelectNationalIdStep/{isNationalID}', {
    method: 'POST',
    headers: {},
});
const data = await response.json();

Response

400

{
  "ErrorCode": "text",
  "Message": "text"
}

#6.2 Upload Passport Image :

POST/api/v1/onboarding/Passport/UploadPassportImage

Header parameters

Body

application/json

customerIdnullable string

imagenullable string

Response

200400

Success

Body

text/plainapplication/jsontext/json

isSuccessboolean

messagenullable string

passportDataGetSessionPassportInfoDto (object)

Request

JavaScriptCurlPythonHTTP

const response = await fetch('/api/v1/onboarding/Passport/UploadPassportImage', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200400

{
  "isSuccess": false,
  "message": "text",
  "passportData": {
    "customerId": "text",
    "firstNameEn": "text",
    "familyNameEn": "text",
    "fullNameEn": "text",
    "fullNameAr": "text",
    "firstNameAr": "text",
    "familyNameAr": "text",
    "birthdate": "2025-01-22T05:11:14.017Z",
    "expirationDate": "2025-01-22T05:11:14.017Z",
    "gender": "text",
    "documentNumber": "text",
    "documentCode": "text",
    "issuingAuthority": "text",
    "nationality": "text",
    "visualZone": "text"
  }
}

#6.3 Approve Passport Info:

POST/api/v1/onboarding/Passport/Approve

Header parameters

Body

application/json

fullNameArnullable string

Response

200400

Success

Request

JavaScriptCurlPythonHTTP

const response = await fetch('/api/v1/onboarding/Passport/Approve', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

400

{
  "ErrorCode": "text",
  "Message": "text"
}