Metropol Full Report
# Request Parameters
The following parameters are expected:
| Field | Description | Type |
|---|---|---|
| search_type | The Search type you want to do. Examples: METROPOLFULLJSON | 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 identitynumber of the person giving consent. _Examples: John Doe | String |
Please find sample implementation on the left
# Response Parameters
Below is a sample response
# Metropol Search
'search_type' is
Metropolandidentity_numberis 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": "XXX.XX",
"last_payment_date": "YYYY-MM-DD",
"loaded_at": "YYYY-MM-DD",
"original_amount": "XXXX.XX",
"overdue_balance": "0.00000",
"overdue_date": null,
"product_type_id": 7
}
],
"api_code": null,
"api_code_description": null,
"association": [],
"credit_score": 260,
"delinquency_code": "004",
"guarantors": [],
"has_error": false,
"has_fraud": false,
"identity_number": "XXXXXXX",
"identity_scrub": {
"api_code": null,
"api_code_description": null,
"bio_nationality": ["KENYA"],
"date_of_being": ["YYYY-MM-DD"],
"email": [],
"employment": [],
"gender": ["F"],
"has_error": false,
"identity_number": "XXXXXXX",
"identity_type": "National ID",
"identity_type_id": "001",
"identity_website": [],
"marital_status": ["M"],
"names": ["XXXXXXXX"],
"phone": ["XXXXXXXX"],
"physical_address": [
{
"address": "XXXXXXXX",
"country": "Kenya",
"plot_number": null,
"town": "XXXXXXXX"
}
],
"postal_address": [
{
"code": "XXXXX",
"country": "Kenya",
"number": "XXXXXXXX",
"town": "XXXXXXXX"
}
]
},
"identity_type": "001",
"identity_verification": {
"api_code": 200,
"api_code_description": null,
"citizenship": "KENYAN",
"date_of_birth": "YYYY-MM-DD",
"error": false,
"first_name": "XXXXXXXX",
"last_name": "XXXXXXXX",
"other_name": "XXXXXXXX",
"surname": "XXXXXXXX",
"gender": "F",
"id_number": "XXXXXXX",
"identity_number": "XXXXXXX",
"identity_type": "001",
"trx_id": "XXXXXXXX"
},
"is_guarantor": false,
"lender_sector": {
"sector_bank": {
"account_npa": 1,
"account_performing": 39,
"account_performing_npa_history": 1
},
"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": 1,
"last_3_months": 0,
"last_6_months": 0
},
"no_of_enquiries": {
"last_12_months": 0,
"last_3_months": 0,
"last_6_months": 0
},
"stakeholders": [],
"trx_id": "XXXXXXXX"
}
}