Developer Docs

Metropol Summary Report

# Request Parameters

The following parameters are expected:

Field Description Type
search_type The Search type you want to do. Examples: Metropol String
identity_number This is the search parameter. E.g. ID Number String
identifier The search parameter type. E.g. National ID String
consent Indicates whether the data owner has consented to identity verification 1 if yes 0 if no.1 if yes 0 if no. String
consent_collected_by Name or identifier of the person giving consent. Examples: John Doe 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_info": [
      {
        "account_number": "XXXXXXX",
        "account_status": "Closed",
        "current_balance": "0.00000",
        "date_opened": "YYYY-MM-DD",
        "days_in_arrears": 0,
        "delinquency_code": "003",
        "highest_days_in_arrears": 0,
        "is_your_account": false,
        "last_payment_amount": "0.00000",
        "last_payment_date": null,
        "loaded_at": "YYYY-MM-DD",
        "original_amount": "XXX.XX",
        "overdue_balance": "0.00000",
        "overdue_date": null,
        "product_type_id": 7
      }
    ],
    "api_code": null,
    "api_code_description": null,
    "credit_score": 760,
    "delinquency_code": "003",
    "has_error": false,
    "has_fraud": false,
    "identity_number": "XXXXXXX",
    "identity_type": "001",
    "is_gurantor": false,
    "lender_sector": {
      "sector_bank": {
        "account_npa": 0,
        "account_performing": 21,
        "account_performing_npa_history": 0
      },
      "sector_other": {
        "account_npa": 0,
        "account_performing": 0,
        "account_performing_npa_history": 0
      }
    },
    "no_of_bounced_cheques": {
      "last_12_months": 0,
      "last_3_months": 0,
      "last_6_months": 0
    },
    "no_of_credit_applications": {
      "last_12_months": 0,
      "last_3_months": 0,
      "last_6_months": 0
    },
    "no_of_enquiries": {
      "last_12_months": 0,
      "last_3_months": 0,
      "last_6_months": 0
    },
    "ppi_analysis": {
      "month": "YYYY-MM-DD",
      "ppi": 8.023,
      "ppi_rank": "M1"
    },
    "reported_name": [
      "XXXXXXXX",
      "XXXXXXXX",
      "XXXXXXXX",
      "XXXXXXXX",
      "XXXXXXXX"
    ],
    "verified_name": {
      "first_name": "XXXXXXXX",
      "other_name": "XXXXXXXX",
      "surname": "XXXXXXXX"
    }
  }
}

← Creditinfo Score →