Developer Docs

Metropol

# Request Parameters

The following parameters are expected:

Field Description Type
search_type The Search type you want to do. Examples: Metropol String
identifier This is the search parameter. E.g. ID Number String

Please find sample implementation on the left

# Response Parameters

Below is a sample response

'search_type' is Metropol and identifier is the client's ID Number

Search details on a customer's Metropol using their ID Number. As sample response is as follows:

{
  "code": "200.001",
  "data": {
    // Account details
    "account_no": "string", // Account number of the customer
    "title": "string | null", // Customer's title (Mr, Mrs, etc)
    "date_created": "string", // ISO8601 timestamp of when record was created
    "id": "string", // Unique identifier (UUID) for the record
    
    // Personal information
    "client_name": "string | null", // Full name of the client
    "phone": "string | null", // Phone number
    "id_no": "string | null", // National ID number
    "passport_no": "string | null", // Passport number if available
    
    // Status and verification
    "status": "string", // Current status of the request (e.g. "Failed", "Success")
    "trend_status": "string | null", // Trend analysis status
    "score_type_name": "string", // Type of credit score (e.g. "Metropol")
    "id_verified": "boolean | null", // Whether ID has been verified
    "passport_verified": "boolean | null", // Whether passport has been verified
    
    // Additional demographics
    "gender": "string | null", // Gender of the client
    "citizenship": "string | null", // Citizenship status
    "ethnic_group": "string | null", // Ethnic group
    "serial_number": "string | null", // Serial number if applicable
    "place_of_birth": "string | null", // Place of birth
    "place_of_live": "string | null" // Current residence
  }
}

← NTSA →