KYC v1

AVAILABLE IN

Côte d'Ivoire Nigeria

Download

Download Postman collection Download Swagger

Available endpoints

GET v1/customers/customers/{customerId}/kyc

Header parameters

transactionId string
Client generated Id to include for tracing requests, so that the API can easily trace the HTTP request all the way from a client to MTNs backend processes (via our proxies). Each time a request is made to an MTN API the client should include a unique request reference in the HTTP Header. The value must be between 5 and 20 characters, and consist of ASCII letters, digits, or the characters +, /, =, and -. Invalid or blank IDs will be ignored and replaced with generated ones. MTN may use this to detect duplicate transactions from the client, but this functionality is not always guaranteed, so clients must make their own efforts to prevent duplicate transactions. MTN will also log the transactionId in order to assist with debugging and to correlate transactions processed by the API to requests from the client.
Content-Type application/json

Auth parameters

apikey x-api-key

Query parameters

startDate string
An optional parameter, together with endDate, allows developers to specify a time range by which to query customer data on. If you want to request data for 2 months, then start date will need to be set to 2 months prior to today, and endDate to todays date. If this is not set, the date range will be defaulted to 6 months
endDate string
An optional parameter, together with endDate, allows developers to specify a time range by which to query customer data on. If you want to request data for 2 months, then start date will need to be set to 2 months prior to today, and endDate to todays date. If this is not set, the date range will be defaulted to 6 months
200OK
data
idType string
Legal ID Type
idNumber string
Legal ID Number/Reference
dateOfBirth string
Date of Birth
gender string
Male,Female
firstName string
Name
lastName string
Surname
_links
self
href string
HATEOS links referring to this object
type string
HTTP methods supported by the HATEOS links above
{
    "data": {
        "idType": "string",
        "idNumber": "string",
        "dateOfBirth": "string",
        "gender": "string",
        "firstName": "string",
        "lastName": "string"
    },
    "_links": {
        "self": {
            "href": "string",
            "type": "string"
        }
    }
}
400Bad Request
timestamp string
Timestamp when the error occurred, using date-time format
status string
HTTP Status code
error string
HTTP Status description
message string
More error details and corrective measures
path string
that URL from which the error originated
{
    "timestamp": "string",
    "status": "string",
    "error": "string",
    "message": "string",
    "path": "string"
}
401Unauthorized
timestamp string
Timestamp when the error occurred, using date-time format
status string
HTTP Status code
error string
HTTP Status description
message string
More error details and corrective measures
path string
that URL from which the error originated
{
    "timestamp": "string",
    "status": "string",
    "error": "string",
    "message": "string",
    "path": "string"
}
403Forbidden
timestamp string
Timestamp when the error occurred, using date-time format
status string
HTTP Status code
error string
HTTP Status description
message string
More error details and corrective measures
path string
that URL from which the error originated
{
    "timestamp": "string",
    "status": "string",
    "error": "string",
    "message": "string",
    "path": "string"
}
404Not Found
timestamp string
Timestamp when the error occurred, using date-time format
status string
HTTP Status code
error string
HTTP Status description
message string
More error details and corrective measures
path string
that URL from which the error originated
{
    "timestamp": "string",
    "status": "string",
    "error": "string",
    "message": "string",
    "path": "string"
}
405Method Not Allowed
timestamp string
Timestamp when the error occurred, using date-time format
status string
HTTP Status code
error string
HTTP Status description
message string
More error details and corrective measures
path string
that URL from which the error originated
{
    "timestamp": "string",
    "status": "string",
    "error": "string",
    "message": "string",
    "path": "string"
}
500Internal Server Error
timestamp string
Timestamp when the error occurred, using date-time format
status string
HTTP Status code
error string
HTTP Status description
message string
More error details and corrective measures
path string
that URL from which the error originated
{
    "timestamp": "string",
    "status": "string",
    "error": "string",
    "message": "string",
    "path": "string"
}