Retrieve Clear MSISDN<\/strong><\/h2>\n\n\n\n

This endpoint enables the caller to call interswitch with a given hashed msisdn so that he can retrieve the clear phone number given that the record exists on interswitch IDS platform.<\/p>\n\n\n\n

Request Data Description<\/strong><\/p>\n\n\n\n

#<\/td>	Field Name<\/td>	Data Type<\/td>	Max Length<\/td>	Required<\/td>	Description<\/td><\/tr>
1<\/td>	msisdn<\/td>	String<\/td>	50<\/td>	Yes<\/td>	This field accept a string of character representing an hashed msisdn that we seek to retrieve the clear msisdn for<\/td><\/tr><\/tbody><\/table>\n\n\n\n Endpoint<\/strong><\/p>\n\n\n\n {{baseurl}}{{ilsbase}}\/verify?msisdn=44D3DCDA61B2AB7A39C61D2B964B2A<\/strong><\/p>\n\n\n\n NOTE: <\/strong>The msisdn<\/strong> in the url is the hashed msisdn that the caller want to retrieve a clear msisdn for<\/p>\n\n\n\n Headers:<\/strong><\/p>\n\n\n\n HTTP Method:<\/strong> GET<\/p>\n\n\n\n Authentication:<\/strong> User Access Token or Client Access Token<\/p>\n\n\n\n C<\/strong>ontent-Type<\/strong>: application\/json<\/p>\n\n\n\n Response:\u00a0{\u00a0“responseCode”: “00”, “responseMessage”: “Successful”, “data”: { “msisdn”: “2348054930703”\u00a0} }<\/td><\/tr><\/tbody><\/table>\n\n\n\n 4.2 Retrieve details an account and bvn  combination owner<\/strong><\/h2>\n\n\n\n Description:  <\/strong>Given the details itemized in the table below, confirm if the supplied BVN and account Number belong to the same entity and retrieve the details of the entity\/account-owner<\/p>\n\n\n\n #<\/td> Field Name<\/td> Data Type<\/td> Max Length \/ Format<\/td> Required<\/td> Description<\/td><\/tr> 1<\/td> bvn<\/td> Integer<\/td> 11<\/td> YES<\/td> The 11 digit individually unique BVN number to be validated<\/td><\/tr> 2<\/td> bank-code<\/td> integer<\/td> 3<\/td> Yes<\/td> The 3 digit unique bank-code assigned by CBN to identify a bank<\/td><\/tr> 3<\/td> account<\/td> Integer<\/td> <\/td> Yes<\/td> The bank account number belonging to the bank-code to be validated against the BVN provided<\/td><\/tr><\/tbody><\/table>\n\n\n\n Endpoint<\/strong><\/p>\n\n\n\n {{baseurl}}\/api\/v1\/request\/verification\/bvn\/{{bvn}}<\/strong>\/bank-code\/{{bank-code}}<\/strong>\/account\/{{account-number}}<\/strong><\/p>\n\n\n\n Sample request call:<\/strong><\/p>\n\n\n\n {{baseurl}}\/api\/v1\/request\/verification\/bvn\/22355202908\/bank-code\/058\/account\/0261642240<\/strong><\/p>\n\n\n\n Headers:<\/strong><\/p>\n\n\n\n HTTP Method<\/strong>: GET<\/p>\n\n\n\n         Authorization<\/strong>: Bearer ACCESS_TOKEN<\/p>\n\n\n\n SUCCESS RESPONSE<\/strong><\/p>\n\n\n\n Description<\/strong><\/p>\n\n\n\n #<\/td> Field Name<\/td> Data Type<\/td> Description<\/td><\/tr> 1<\/td> responseCode<\/td> String<\/td> The code representing the state of the response, it show whether the response was a success or not. NB: “00” is the code for success<\/td><\/tr> 2<\/td> responseMessage<\/td> String<\/td> The description that explains the responseCode from above <\/td><\/tr> 3<\/td> data<\/td> Object<\/td> The section that contains the account owner details<\/td><\/tr> 4<\/td> bvn<\/td> String<\/td> BVN of the owner of the account, would always be same as the BVN supplied in the request if it was successful<\/td><\/tr> 5<\/td> accountNumber<\/td> String<\/td> Account number of the owner of the account, would always be same as the account number supplied in the request if it was successful<\/td><\/tr> 6<\/td> bankCode<\/td> String<\/td> The bankcode used to identify the bank, would always be same as the bank-code supplied in the request if it was successful<\/td><\/tr> 7<\/td> accountName<\/td> String<\/td> Full names of the account holder<\/td><\/tr> 8<\/td> dob<\/td> String<\/td> The account holder date of birth (Format: dd-MMM-yy)<\/td><\/tr> 9<\/td> firstName<\/td> String<\/td> The account holder\u2019s first name<\/td><\/tr> 10<\/td> lastName<\/td> String<\/td> The account holder\u2019s last name<\/td><\/tr> 9<\/td> phone<\/td> String<\/td> The account holder\u2019s mobile phone number<\/td><\/tr> 10<\/td> residentialAddress<\/td> String<\/td> The account holder\u2019s residential address<\/td><\/tr><\/tbody><\/table>\n\n\n\n Success sample response<\/strong><\/p>\n\n\n\n Response :{ “responseCode”: “00”, \u00a0 \u00a0 “responseMessage”: “Successful”, \u00a0 \u00a0 \u00a0“data”: { “bvn”: “22292083231”, “accountNumber”: “0696363603”, “accountName”: “MICHEAL SYDENY EDE”, “bankCode”: “044”, “firstName”: “MICHEAL”, “lastName”: “EDE”, “dob”: “12-Mar-75”, “phone”: “08064088818”, “residentialAddress”: “SHEHU AUDI RESIDENCE, FUNTUA STREET, KAFANCHAN” \u00a0 \u00a0 \u00a0} } <\/td><\/tr><\/tbody><\/table>\n\n\n\n FAILURE RESPONSE<\/strong><\/p>\n\n\n\n Description<\/strong><\/p>\n\n\n\n #<\/td> Field Name<\/td> Data Type<\/td> Description<\/td><\/tr> 1<\/td> responseCode<\/td> String<\/td> The code representing the state of the response, it show whether the response was a success or not. NB: “00” is the code for success<\/td><\/tr> 2<\/td> responseMessage<\/td> String<\/td> The description that explains the responseCode from above <\/td><\/tr><\/tbody><\/table>\n\n\n\n Failure sample response<\/strong><\/p>\n\n\n\n Response :{\n    “responseCode”: “10404”,\n    “responseMessage”: “No Information Found – No Information Found For Account Details”,\n}\n<\/td><\/tr><\/tbody><\/table>\n\n\n\n 4.3 Validate an account and bvn  combination<\/strong><\/h2>\n\n\n\n Description:  <\/strong>Given the details itemized in the table below, confirm if the supplied BVN and account Number belong to the same entity<\/p>\n\n\n\n #<\/td> Field Name<\/td> Data Type<\/td> Max Length \/ Format<\/td> Required<\/td> Description<\/td><\/tr> 1<\/td> bvn<\/td> Integer<\/td> 11<\/td> YES<\/td> The 11 digit individually unique BVN number to be validated<\/td><\/tr> 2<\/td> bank-code<\/td> integer<\/td> 3<\/td> Yes<\/td> The 3 digit unique bank-code assigned by CBN to identify a bank<\/td><\/tr> 3<\/td> account<\/td> Integer<\/td> <\/td> Yes<\/td> The bank account number belonging to the bank-code to be validated against the BVN provided<\/td><\/tr><\/tbody><\/table>\n\n\n\n Endpoint<\/strong><\/p>\n\n\n\n {{baseurl}}\/api\/v1\/request\/validate\/bvn\/{{bvn}}<\/strong>\/bank-code\/{{bank-code}}<\/strong>\/account\/{{account-number}}<\/strong><\/p>\n\n\n\n Sample request call:<\/strong><\/p>\n\n\n\n {{baseurl}}\/api\/v1\/request\/validate\/bvn\/22355202908\/bank-code\/058\/account\/0261642240<\/strong><\/p>\n\n\n\n Headers:<\/strong><\/p>\n\n\n\n HTTP Method<\/strong>: GET<\/p>\n\n\n\n         Authorization<\/strong>: Bearer ACCESS_TOKEN<\/p>\n\n\n\n SUCCESS RESPONSE<\/strong><\/p>\n\n\n\n Description<\/strong><\/p>\n\n\n\n #<\/td> Field Name<\/td> Data Type<\/td> Description<\/td><\/tr> 1<\/td> responseCode<\/td> String<\/td> The code representing the state of the response, it show whether the response was a success or not. NB: “00” is the code for success<\/td><\/tr> 2<\/td> responseMessage<\/td> String<\/td> The description that explains the responseCode from above <\/td><\/tr> 3<\/td> data<\/td> Object<\/td> The section that contains the actual data requested by the request<\/td><\/tr> 4<\/td> type<\/td> String<\/td> Description of what is verification status is for<\/td><\/tr> 5<\/td> isVerified<\/td> String<\/td> returns either a YES or NO, signifying if the supplied BVN and AccountNumber has a match and both belong to the same entity<\/td><\/tr><\/tbody><\/table>\n\n\n\n Success sample response<\/strong><\/p>\n\n\n\n Response :{\n    “responseCode”: “00”,\n    “responseMessage”: “Successful”,\n     “data”: {\n         “type”: “BVN and AccountNumber validation”,\n         “isVerified”: “YES”\n     }\n}\n<\/td><\/tr><\/tbody><\/table>\n\n\n\n FAILURE RESPONSE<\/strong><\/p>\n\n\n\n Description<\/strong><\/p>\n\n\n\n #<\/td> Field Name<\/td> Data Type<\/td> Description<\/td><\/tr> 1<\/td> responseCode<\/td> String<\/td> The code representing the state of the response, it show whether the response was a success or not. NB: “00” is the code for success<\/td><\/tr> 2<\/td> responseMessage<\/td> String<\/td> The description that explains the responseCode from above <\/td><\/tr><\/tbody><\/table>\n\n\n\n Failure sample response<\/strong><\/p>\n\n\n\n Response :{\n    “responseCode”: “10404”,\n    “responseMessage”: “No Information Found – No Information Found For Account Details”,\n}\n<\/td><\/tr><\/tbody><\/table>\n\n\n\n 4.4 Validate an individual<\/strong><\/h2>\n\n\n\n Description:  <\/strong>Given validation type and validation ID, and other details itemized in the table below, confirm that a person exist on the KYC platform. The system will confirm the details specified in the request body,  and will also return a response with details based on the validation on the platform. A sample request and response for this call is available below: <\/p>\n\n\n\n #<\/td> Field Name<\/td> Data Type<\/td> Max Length \/ Format<\/td> Required<\/td> Description<\/td><\/tr> 1<\/td> validationType<\/td> String<\/td> <\/td> YES<\/td> The type of identification means that is been used to verify the individual, can be one of either NIN, BVN<\/strong><\/td><\/tr> 2<\/td> validationId<\/td> String<\/td> <\/td> Yes<\/td> The unique identification number for that validationType that should point to that unique individual being verified<\/td><\/tr> 3<\/td> firstname<\/td> String<\/td> <\/td> Yes<\/td> The firstName of the individual to be vetted against the firstName of the validation ID holder on the KYC platform<\/td><\/tr> 4<\/td> lastname<\/td> String<\/td> <\/td> Yes<\/td> The lastName of the individual to be vetted against the lastName of the validation ID holder on the KYC platform<\/td><\/tr> 5<\/td> birthDate<\/td> Date<\/td> yyyy-MM-dd<\/td> Yes<\/td> The date of birth of the individual to be vetted against the date of birth of the validation ID holder on the KYC platform<\/td><\/tr> 6<\/td> gender<\/td> String<\/td> <\/td> Yes<\/td> The gender of the individual to be vetted against the gender of the validation ID holder on the KYC platform<\/td><\/tr> 7<\/td> phone<\/td> String<\/td> <\/td> Yes<\/td> The phone number of the individual to be vetted against the phone number of the validation ID holder on the KYC platform<\/td><\/tr><\/tbody><\/table>\n\n\n\n Endpoint<\/strong><\/p>\n\n\n\n {{baseurl}}\/api\/v1\/request\/verification<\/strong><\/p>\n\n\n\n Headers:<\/strong><\/p>\n\n\n\n HTTP Method<\/strong>: POST<\/p>\n\n\n\n         Content-Type<\/strong>: application\/json<\/p>\n\n\n\n         Authorization<\/strong>: Bearer access token<\/p>\n\n\n\n Request: {\n    “firstname”: “john”,\n    “lastname”: “doe”,\n    “birthDate”: “1990-01-01”,\n    “gender”: “male”,\n    “phone”: “08030000000”,\n    “validationType”: “BVN”,\n    “validationId”: “11111111111”\n}\n<\/td><\/tr><\/tbody><\/table>\n\n\n\n Response :{ \u00a0 \u00a0 “responseCode”: “00”, \u00a0 \u00a0 “responseMessage”: Successful, \u00a0 \u00a0 \u00a0 “data”: { “type”: “BVN”, \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 “status”: “VERIFIED”, \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 “identityNumber”: “11111111111”, \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 “lastName”: “Doe”, \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 “firstName”: “John”, \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 “birthDate”: “1990-01-01”, \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 “reference”: “ISW|KYC|BVN|20200714|WFWVVCSBI” \u00a0 \u00a0 \u00a0} } <\/td><\/tr><\/tbody><\/table>\n\n\n\n 4.5<\/strong>Validate<\/strong> the BVN and Account Number individual<\/strong><\/h2>\n\n\n\n Description:  <\/strong>Given a specific validation request as detailed in table below, confirm that the individual with the account number and bvn specified exists. The system returns a YES in the data section of the response if the individual exists and is linked to the provided bvn. Otherwise, a NO is returned in the data section of the response.<\/p>\n\n\n\n #<\/td> Field Name<\/td> Data Type<\/td> Max Length \/ Format<\/td> Required<\/td> Description<\/td><\/tr> 1<\/td> firstname<\/td> String<\/td> <\/td> Yes<\/td> The firstName of the individual to be vetted against the BVN and bank account details<\/td><\/tr> 2<\/td> lastname<\/td> String<\/td> <\/td> Yes<\/td> The lastName of the individual to be vetted against the BVN and bank account details<\/td><\/tr> 3<\/td> birthDate<\/td> Date<\/td> yyyy-MM-dd<\/td> Yes<\/td> The date of birth of the individual to be vetted against the BVN and bank account details<\/td><\/tr> 4<\/td> gender<\/td> String<\/td> <\/td> Yes<\/td> The gender of the individual to be vetted against the BVN and bank account details<\/td><\/tr> 5<\/td> phone<\/td> String<\/td> <\/td> Yes<\/td> The phone number of the individual to be vetted against the BVN and bank account details<\/td><\/tr> 6<\/td> bvn<\/td> String<\/td> 11<\/td> Yes<\/td> The BVN of the individual to be vetted<\/td><\/tr> 7<\/td> accountNumber<\/td> String<\/td> <\/td> Yes<\/td> The account number of the individual whose details is to be vetted against the provided details<\/td><\/tr> 8<\/td> bankCode<\/td> String<\/td> <\/td> Yes<\/td> The CBN approved unique bankCcode for the bank the account is in<\/td><\/tr> 9<\/td> country<\/td> String<\/td> <\/td> Yes<\/td> The unique shortCode for the country the individuals bank is in<\/td><\/tr><\/tbody><\/table>\n\n\n\n Endpoint<\/strong><\/p>\n\n\n\n {{baseurl}}\/api\/v1\/request\/verification\/bvn\/account<\/strong><\/p>\n\n\n\n Headers: <\/strong><\/p>\n\n\n\n HTTP Method<\/strong>: POST<\/p>\n\n\n\n Content-Type<\/strong>: application\/json<\/p>\n\n\n\n Authorization<\/strong>: Bearer access token<\/p>\n\n\n\n Request:\u00a0\u00a0{ “firstname”: “john”, \u00a0 \u00a0 “lastname”: “doe”, \u00a0 \u00a0 “birthDate”: “1990-01-01”, \u00a0 \u00a0 “gender”: “male”, \u00a0 \u00a0 “phone”: “08030000000”, \u00a0 \u00a0 “bvn”: “11111111111”, \u00a0 \u00a0 “accountNumber”: “0696363603”, \u00a0 \u00a0 “bankCode”: “044”, \u00a0 \u00a0 “country”: “NGA” } <\/td><\/tr><\/tbody><\/table>\n\n\n\n Response :{ \u00a0 \u00a0 “responseCode”: “00”, \u00a0 \u00a0 “responseMessage”: Successful, \u00a0 \u00a0 “data”: { \u00a0 “type”: “BVN and Bank Account verification”, \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 “isVerified”: “NO” \u00a0 \u00a0 } } <\/td><\/tr><\/tbody><\/table>\n","protected":false},"author":228,"featured_media":0,"parent":3577,"menu_order":4,"comment_status":"open","ping_status":"closed","template":"","meta":{"spay_email":""},"doc_tag":[],"_links":{"self":[{"href":"https:\/\/sandbox.interswitchng.com\/docbase\/wp-json\/wp\/v2\/docs\/4194"}],"collection":[{"href":"https:\/\/sandbox.interswitchng.com\/docbase\/wp-json\/wp\/v2\/docs"}],"about":[{"href":"https:\/\/sandbox.interswitchng.com\/docbase\/wp-json\/wp\/v2\/types\/docs"}],"author":[{"embeddable":true,"href":"https:\/\/sandbox.interswitchng.com\/docbase\/wp-json\/wp\/v2\/users\/228"}],"replies":[{"embeddable":true,"href":"https:\/\/sandbox.interswitchng.com\/docbase\/wp-json\/wp\/v2\/comments?post=4194"}],"version-history":[{"count":1,"href":"https:\/\/sandbox.interswitchng.com\/docbase\/wp-json\/wp\/v2\/docs\/4194\/revisions"}],"predecessor-version":[{"id":4195,"href":"https:\/\/sandbox.interswitchng.com\/docbase\/wp-json\/wp\/v2\/docs\/4194\/revisions\/4195"}],"up":[{"embeddable":true,"href":"https:\/\/sandbox.interswitchng.com\/docbase\/wp-json\/wp\/v2\/docs\/3577"}],"next":[{"title":"Collections Dataset","link":"https:\/\/sandbox.interswitchng.com\/docbase\/docs\/interswitch-data-service\/collections-dataset\/","href":"https:\/\/sandbox.interswitchng.com\/docbase\/wp-json\/wp\/v2\/docs\/4196"}],"prev":[{"title":"Profile Analysis","link":"https:\/\/sandbox.interswitchng.com\/docbase\/docs\/interswitch-data-service\/profile-analysis-2\/","href":"https:\/\/sandbox.interswitchng.com\/docbase\/wp-json\/wp\/v2\/docs\/3656"}],"wp:attachment":[{"href":"https:\/\/sandbox.interswitchng.com\/docbase\/wp-json\/wp\/v2\/media?parent=4194"}],"wp:term":[{"taxonomy":"doc_tag","embeddable":true,"href":"https:\/\/sandbox.interswitchng.com\/docbase\/wp-json\/wp\/v2\/doc_tag?post=4194"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}