Importapay
Api reference

GET /api/merchant/pobo/reference/identity-documents/:country

Fetch the identity-document requirements before rendering a person's document upload fields. Replace :country with an uppercase ISO alpha-2 country code, for example NG or US.

Use each returned type exactly as associated_persons[].id_type and identity_files[].file_type. Upload a base64-encoded file for every required part; when the response requires both sides, submit separate FRONT and BACK entries.

This endpoint requires the merchant API key in x-api-key.

Response

{
  "message": "identity documents fetched",
  "response": [
    {
      "type": "PASSPORT",
      "required_parts": ["FRONT"],
      "back_required": false
    }
  ]
}

On this page