💳Update National Id

1. Verify Password

post

Authorizations

JWT

AuthorizationstringRequired

Please insert JWT with Bearer into field

Header parameters

Accept-LanguageStringOptional

AuthorizationstringOptional

ex: Bearer <Replace Token From Third Step (Select Step)>

Body

application/json

passwordstring · nullableOptional

updateStepIdinteger · enumOptionalPossible values:

Responses

200

Success

text/plainapplication/jsontext/json

400

Bad Request

text/plainapplication/jsontext/json

post

/api/v1/update/UpdateRequest/VerifyPassword

HTTPcURLJavaScriptPython

POST /api/v1/update/UpdateRequest/VerifyPassword HTTP/1.1
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 36

{
  "password": "text",
  "updateStepId": 1
}

{
  "status": 0
}

Upload National Id Front Image :

post

Authorizations

JWT

AuthorizationstringRequired

Please insert JWT with Bearer into field

Header parameters

Accept-LanguageStringOptional

AuthorizationstringOptional

ex: Bearer <Replace Token From Third Step (Select Step)>

Body

application/json

customerIdstring · nullableOptional

imagestring · nullableOptional

Responses

200

Success

text/plainapplication/jsontext/json

400

Bad Request

text/plainapplication/jsontext/json

post

/api/v1/update/UpdateNationalId/UploadFrontImage

HTTPcURLJavaScriptPython

POST /api/v1/update/UpdateNationalId/UploadFrontImage HTTP/1.1
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": "2026-01-27T17:25:34.304Z",
    "idNumber": "text",
    "idNumberBack": "text",
    "documentNumber": "text",
    "documentTypeId": "text",
    "documentTypeCode": "text",
    "issueDate": "2026-01-27T17:25:34.304Z",
    "profession": "text",
    "maritalStatus": "text",
    "religion": "text",
    "gender": "text",
    "nationality": "text",
    "detectedAge": 1,
    "detectedGender": "text",
    "expirationDate": "2026-01-27T17:25:34.304Z"
  }
}

Upload National Id Back Image :

post

Authorizations

JWT

AuthorizationstringRequired

Please insert JWT with Bearer into field

Header parameters

Accept-LanguageStringOptional

AuthorizationstringOptional

ex: Bearer <Replace Token From Third Step (Select Step)>

Body

application/json

customerIdstring · nullableOptional

imagestring · nullableOptional

Responses

200

Success

text/plainapplication/jsontext/json

400

Bad Request

text/plainapplication/jsontext/json

post

/api/v1/update/UpdateNationalId/UploadBackImage

HTTPcURLJavaScriptPython

POST /api/v1/update/UpdateNationalId/UploadBackImage HTTP/1.1
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": "2026-01-27T17:25:34.304Z",
    "idNumber": "text",
    "idNumberBack": "text",
    "documentNumber": "text",
    "documentTypeId": "text",
    "documentTypeCode": "text",
    "issueDate": "2026-01-27T17:25:34.304Z",
    "profession": "text",
    "maritalStatus": "text",
    "religion": "text",
    "gender": "text",
    "nationality": "text",
    "detectedAge": 1,
    "detectedGender": "text",
    "expirationDate": "2026-01-27T17:25:34.304Z"
  }
}

Approve National Id Front Image :

post

Authorizations

JWT

AuthorizationstringRequired

Please insert JWT with Bearer into field

Header parameters

Accept-LanguageStringOptional

AuthorizationstringOptional

ex: Bearer <Replace Token From Third Step (Select Step)>

Body

application/json

fullNameEnstring · nullableOptional

firstNameEnstring · nullableOptional

familyNameEnstring · nullableOptional

Responses

200

Success

text/plainapplication/jsontext/json

400

Bad Request

text/plainapplication/jsontext/json

post

/api/v1/update/UpdateNationalId/ApproveFrontImage

HTTPcURLJavaScriptPython

POST /api/v1/update/UpdateNationalId/ApproveFrontImage HTTP/1.1
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 64

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

{
  "status": 0
}

Approve National Id Back Image :

post

Authorizations

JWT

AuthorizationstringRequired

Please insert JWT with Bearer into field

Header parameters

Accept-LanguageStringOptional

AuthorizationstringOptional

ex: Bearer <Replace Token From Third Step (Select Step)>

Responses

200

Success

text/plainapplication/jsontext/json

400

Bad Request

text/plainapplication/jsontext/json

post

/api/v1/update/UpdateNationalId/ApproveBackImage

HTTPcURLJavaScriptPython

POST /api/v1/update/UpdateNationalId/ApproveBackImage HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

{
  "status": 0
}

Check If Translation Is Enabled

get

Authorizations

JWT

AuthorizationstringRequired

Please insert JWT with Bearer into field

Header parameters

Accept-LanguageStringOptional

AuthorizationstringOptional

ex: Bearer <Replace Token From Third Step (Select Step)>

Responses

200

Success

text/plainapplication/jsontext/json

400

Bad Request

text/plainapplication/jsontext/json

get

/api/v1/update/UpdateNationalId/IsTranaslationStepEnabled

HTTPcURLJavaScriptPython

GET /api/v1/update/UpdateNationalId/IsTranaslationStepEnabled HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

{
  "value": true
}