{ "info": { "name": "Mobile Carrier KYC API", "schema": "https:\/\/schema.getpostman.com\/json\/collection\/v2.1.0\/collection.json" }, "item": [ { "name": "Match subscriber national identity number with mobile network operator.", "description": "Verify if the national identity number provided matches subscriber data with the relevant mobile network operator as identified by the 'phoneNumber' value provided.", "request": { "auth": { "type": "oauth2", "oauth2": [ { "key": "addTokenTo", "value": "header", "type": "string" } ] }, "method": "Get", "header": [ { "key": "Content-Type", "name": "Content-Type", "value": "application\/json", "type": "application\/json", "description": "" } ], "url": { "raw": "api.host.com\/mobile\/subscribers\/{phoneNumber}\/verify-id-number", "protocol": "https", "host": [ "api", "host", "com" ], "path": { "1": "mobile", "2": "subscribers", "3": "{phoneNumber}", "4": "verify-id-number" }, "query": [ { "key": "nationalIdNumber", "value": "", "required": true, "type": "string", "description": "This is the ID number to be verified with mobile network operator" } ] } }, "response": [ { "code": 200, "status": "OK", "name": "Success", "schema": { "statusCode": { "type": "integer", "description": "HTTP error code extension" }, "statusMessage": { "type": "string", "description": "Corresponding message." }, "phoneNumber": { "type": "string", "example": 27123456789, "description": "phoneNumber provided in the input" }, "data": { "nationalIdNumber": { "type": "string", "example": "ABC123456789", "description": "NationalIdNumber value that was passed to be matched with phoneNumber data." }, "nationalIdNumberMatch": { "type": "string", "default": "", "description": "Y,N-NA,N-AV,N-AD" } }, "transactionId": { "type": "string", "description": "Transaction ID for tracing" } }, "body": "{\"statusCode\":1,\"statusMessage\":\"string\",\"phoneNumber\":\"string\",\"data\":{\"nationalIdNumber\":\"string\",\"nationalIdNumberMatch\":\"string\"},\"transactionId\":\"string\"}", "header": [ { "key": "Content-Type", "value": "application\/json", "description": "Sending as JSON", "type": "string" } ] }, { "code": 400, "status": "Bad Request", "name": "Bad Request", "schema": { "statusCode": { "type": "integer", "description": "HTTP error code extension" }, "statusMessage": { "type": "string", "description": "More details and corrective actions related to the error which can be shown to a client." }, "SupportMessage": { "type": "string", "description": "Support Message" } }, "body": "{\"statusCode\":1,\"statusMessage\":\"string\",\"SupportMessage\":\"string\"}", "header": [ { "key": "Content-Type", "value": "application\/json", "description": "Sending as JSON", "type": "string" } ] }, { "code": 401, "status": "Unauthorized", "name": "Unauthorized", "schema": { "statusCode": { "type": "integer", "description": "HTTP error code extension" }, "statusMessage": { "type": "string", "description": "More details and corrective actions related to the error which can be shown to a client." }, "SupportMessage": { "type": "string", "description": "Support Message" } }, "body": "{\"statusCode\":1,\"statusMessage\":\"string\",\"SupportMessage\":\"string\"}", "header": [ { "key": "Content-Type", "value": "application\/json", "description": "Sending as JSON", "type": "string" } ] }, { "code": 403, "status": "Forbidden", "name": "Forbidden", "schema": { "statusCode": { "type": "integer", "description": "HTTP error code extension" }, "statusMessage": { "type": "string", "description": "More details and corrective actions related to the error which can be shown to a client." }, "SupportMessage": { "type": "string", "description": "Support Message" } }, "body": "{\"statusCode\":1,\"statusMessage\":\"string\",\"SupportMessage\":\"string\"}", "header": [ { "key": "Content-Type", "value": "application\/json", "description": "Sending as JSON", "type": "string" } ] }, { "code": 404, "status": "Not Found", "name": "Not Found", "schema": { "statusCode": { "type": "integer", "description": "HTTP error code extension" }, "statusMessage": { "type": "string", "description": "More details and corrective actions related to the error which can be shown to a client." }, "SupportMessage": { "type": "string", "description": "Support Message" } }, "body": "{\"statusCode\":1,\"statusMessage\":\"string\",\"SupportMessage\":\"string\"}", "header": [ { "key": "Content-Type", "value": "application\/json", "description": "Sending as JSON", "type": "string" } ] }, { "code": 405, "status": "Method Not Allowed", "name": "Method No Allowed", "schema": { "statusCode": { "type": "integer", "description": "HTTP error code extension" }, "statusMessage": { "type": "string", "description": "More details and corrective actions related to the error which can be shown to a client." }, "SupportMessage": { "type": "string", "description": "Support Message" } }, "body": "{\"statusCode\":1,\"statusMessage\":\"string\",\"SupportMessage\":\"string\"}", "header": [ { "key": "Content-Type", "value": "application\/json", "description": "Sending as JSON", "type": "string" } ] }, { "code": 406, "status": "Not Acceptable", "name": "Not acceptable", "schema": { "statusCode": { "type": "integer", "description": "HTTP error code extension" }, "statusMessage": { "type": "string", "description": "More details and corrective actions related to the error which can be shown to a client." }, "SupportMessage": { "type": "string", "description": "Support Message" } }, "body": "{\"statusCode\":1,\"statusMessage\":\"string\",\"SupportMessage\":\"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": { "statusCode": { "type": "integer", "description": "HTTP error code extension" }, "statusMessage": { "type": "string", "description": "More details and corrective actions related to the error which can be shown to a client." }, "SupportMessage": { "type": "string", "description": "Support Message" } }, "body": "{\"statusCode\":1,\"statusMessage\":\"string\",\"SupportMessage\":\"string\"}", "header": [ { "key": "Content-Type", "value": "application\/json", "description": "Sending as JSON", "type": "string" } ] } ] } ] }