{ "info": { "name": "MTN Customer KYC API", "schema": "https:\/\/schema.getpostman.com\/json\/collection\/v2.1.0\/collection.json" }, "item": [ { "name": "Retrieve customer KYC data", "description": "", "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-api-key", "type": "string" } ] }, "method": "Get", "header": { "3": { "key": "transactionId", "name": "transactionId", "value": "", "type": "string", "description": "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." }, "4": { "key": "Content-Type", "name": "Content-Type", "value": "application\/json", "type": "application\/json", "description": "" } }, "url": { "raw": "api.mtn.com\/customers\/{customerId}\/kyc", "protocol": "https", "host": [ "api", "mtn", "com" ], "path": [ "v1", "customers", "customers", "{customerId}", "kyc" ], "query": [ { "key": "startDate", "value": "", "required": 0, "type": "string", "description": "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" }, { "key": "endDate", "value": "", "required": 0, "type": "string", "description": "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" } ] } }, "response": [ { "code": 200, "status": "OK", "name": "OK", "schema": { "data": { "idType": { "type": "string", "description": "Legal ID Type", "example": "South African ID" }, "idNumber": { "type": "string", "description": "Legal ID Number\/Reference", "example": "8002143987083" }, "dateOfBirth": { "type": "string", "format": "date", "description": "Date of Birth", "pattern": "YYYY-MM-DD", "example": "1980-02-14" }, "gender": { "type": "string", "default": "", "description": "Male,Female" }, "firstName": { "type": "string", "description": "Name", "example": "First n Middle" }, "lastName": { "type": "string", "description": "Surname", "example": "Surname" } }, "_links": { "self": { "href": { "type": "string", "description": "HATEOS links referring to this object", "example": "https:\/\/api.mtn.com\/v1\/customers\/27832000000\/kyc" }, "type": { "type": "string", "description": "HTTP methods supported by the HATEOS links above", "example": "GET, POST" } } } }, "body": "{\"data\":{\"idType\":\"string\",\"idNumber\":\"string\",\"dateOfBirth\":\"string\",\"gender\":\"string\",\"firstName\":\"string\",\"lastName\":\"string\"},\"_links\":{\"self\":{\"href\":\"string\",\"type\":\"string\"}}}", "header": [ { "key": "Content-Type", "value": "application\/json", "description": "Sending as JSON", "type": "string" } ] }, { "code": 400, "status": "Bad Request", "name": "Bad Request. A Bad Request response is returned when the path info doesn't have the right format, or a parameter or request body value doesn't have the right format, or a required parameter is missing, or values have the right format but are invalid in some way. The client SHOULD NOT repeat the request without modifications.", "schema": { "timestamp": { "type": "string", "format": "date-time", "description": "Timestamp when the error occurred, using date-time format", "example": "2019-08-23T07:29:25.593+0000\u201d" }, "status": { "type": "string", "description": "HTTP Status code", "example": "404" }, "error": { "type": "string", "description": "HTTP Status description", "example": "Not Found" }, "message": { "type": "string", "description": "More error details and corrective measures", "example": "No message available" }, "path": { "type": "string", "description": "that URL from which the error originated", "example": "\/customers\/2783200000\/subscriptions\/AG8cfc7353e-23b0-578f-a041-b8bf5ef76418:23-08-201907:27:38AMGMT\/status\u201d" } }, "body": "{\"timestamp\":\"string\",\"status\":\"string\",\"error\":\"string\",\"message\":\"string\",\"path\":\"string\"}", "header": [ { "key": "Content-Type", "value": "application\/json", "description": "Sending as JSON", "type": "string" } ] }, { "code": 401, "status": "Unauthorized", "name": "Unauthorized", "schema": { "timestamp": { "type": "string", "format": "date-time", "description": "Timestamp when the error occurred, using date-time format", "example": "2019-08-23T07:29:25.593+0000\u201d" }, "status": { "type": "string", "description": "HTTP Status code", "example": "404" }, "error": { "type": "string", "description": "HTTP Status description", "example": "Not Found" }, "message": { "type": "string", "description": "More error details and corrective measures", "example": "No message available" }, "path": { "type": "string", "description": "that URL from which the error originated", "example": "\/customers\/2783200000\/subscriptions\/AG8cfc7353e-23b0-578f-a041-b8bf5ef76418:23-08-201907:27:38AMGMT\/status\u201d" } }, "body": "{\"timestamp\":\"string\",\"status\":\"string\",\"error\":\"string\",\"message\":\"string\",\"path\":\"string\"}", "header": [ { "key": "Content-Type", "value": "application\/json", "description": "Sending as JSON", "type": "string" } ] }, { "code": 403, "status": "Forbidden", "name": "Forbidden", "schema": { "timestamp": { "type": "string", "format": "date-time", "description": "Timestamp when the error occurred, using date-time format", "example": "2019-08-23T07:29:25.593+0000\u201d" }, "status": { "type": "string", "description": "HTTP Status code", "example": "404" }, "error": { "type": "string", "description": "HTTP Status description", "example": "Not Found" }, "message": { "type": "string", "description": "More error details and corrective measures", "example": "No message available" }, "path": { "type": "string", "description": "that URL from which the error originated", "example": "\/customers\/2783200000\/subscriptions\/AG8cfc7353e-23b0-578f-a041-b8bf5ef76418:23-08-201907:27:38AMGMT\/status\u201d" } }, "body": "{\"timestamp\":\"string\",\"status\":\"string\",\"error\":\"string\",\"message\":\"string\",\"path\":\"string\"}", "header": [ { "key": "Content-Type", "value": "application\/json", "description": "Sending as JSON", "type": "string" } ] }, { "code": 404, "status": "Not Found", "name": "Customer not found", "schema": { "timestamp": { "type": "string", "format": "date-time", "description": "Timestamp when the error occurred, using date-time format", "example": "2019-08-23T07:29:25.593+0000\u201d" }, "status": { "type": "string", "description": "HTTP Status code", "example": "404" }, "error": { "type": "string", "description": "HTTP Status description", "example": "Not Found" }, "message": { "type": "string", "description": "More error details and corrective measures", "example": "No message available" }, "path": { "type": "string", "description": "that URL from which the error originated", "example": "\/customers\/2783200000\/subscriptions\/AG8cfc7353e-23b0-578f-a041-b8bf5ef76418:23-08-201907:27:38AMGMT\/status\u201d" } }, "body": "{\"timestamp\":\"string\",\"status\":\"string\",\"error\":\"string\",\"message\":\"string\",\"path\":\"string\"}", "header": [ { "key": "Content-Type", "value": "application\/json", "description": "Sending as JSON", "type": "string" } ] }, { "code": 405, "status": "Method Not Allowed", "name": "Method Not allowed", "schema": { "timestamp": { "type": "string", "format": "date-time", "description": "Timestamp when the error occurred, using date-time format", "example": "2019-08-23T07:29:25.593+0000\u201d" }, "status": { "type": "string", "description": "HTTP Status code", "example": "404" }, "error": { "type": "string", "description": "HTTP Status description", "example": "Not Found" }, "message": { "type": "string", "description": "More error details and corrective measures", "example": "No message available" }, "path": { "type": "string", "description": "that URL from which the error originated", "example": "\/customers\/2783200000\/subscriptions\/AG8cfc7353e-23b0-578f-a041-b8bf5ef76418:23-08-201907:27:38AMGMT\/status\u201d" } }, "body": "{\"timestamp\":\"string\",\"status\":\"string\",\"error\":\"string\",\"message\":\"string\",\"path\":\"string\"}", "header": [ { "key": "Content-Type", "value": "application\/json", "description": "Sending as JSON", "type": "string" } ] }, { "code": 500, "status": "Internal Server Error", "name": "Internal Server Error", "schema": { "timestamp": { "type": "string", "format": "date-time", "description": "Timestamp when the error occurred, using date-time format", "example": "2019-08-23T07:29:25.593+0000\u201d" }, "status": { "type": "string", "description": "HTTP Status code", "example": "404" }, "error": { "type": "string", "description": "HTTP Status description", "example": "Not Found" }, "message": { "type": "string", "description": "More error details and corrective measures", "example": "No message available" }, "path": { "type": "string", "description": "that URL from which the error originated", "example": "\/customers\/2783200000\/subscriptions\/AG8cfc7353e-23b0-578f-a041-b8bf5ef76418:23-08-201907:27:38AMGMT\/status\u201d" } }, "body": "{\"timestamp\":\"string\",\"status\":\"string\",\"error\":\"string\",\"message\":\"string\",\"path\":\"string\"}", "header": [ { "key": "Content-Type", "value": "application\/json", "description": "Sending as JSON", "type": "string" } ] } ] } ] }