TIN Full Details Verification Service
Overview
The TIN Full details service accepts the TIN and country code and returns detailed information on the Tax Identification. This article will guide you on how to integrate to the TIN Full Details Service
Important!
Before you proceed, ensure you review the prerequisites for integrating to our APIs for a more detailed guide.
API Endpoint
https://api.verified.africa/sfx-verify/v3/id-service/
Headers
Our service accepts headers for authentication. See below the headers to pass to the API
| Header | Type | Description |
|---|---|---|
| userid | String | This is your user id retrieved from the portal. Check the getting started article to understand how to retrieve your userid |
| apiKey | String | This is your api key retrieved from the portal. Check the getting started article to understand how to retrieve your apiKey |
Request
| Request Parameter | Description | Description | Test Data |
|---|---|---|---|
| searchParameter | Required | The TIN will be passed into this field | 00000000-0000 |
| verificationType | Required | This field is used to identify the service being called. Ensure to use the value provided exactly as provided | TIN-FULL-DETAIL-VERIFICATION |
{
"verificationType": "TIN-FULL-DETAIL-VERIFICATION",
"searchParameter":"00000000-0000"
}
Response
| Response Parameter | Type | Description |
|---|---|---|
| responseCode | String | Please reference Response Codes page for details on all possible responses |
| description | String | This is a description of the response received. |
| verificationType | String | The same verificationType passed in request will be returned here |
| verificationStatus | String | This field lets you know if the identity verification was successful. Options are: VERIFIED: This means that the TIN is valid. NOT VERIFIED This means that the /TIN is invalid PENDING This status means that the verification could not be completed. Refer to the responseCode for the specific failure reason |
| transactionStatus | String | This indicates the wallet debit status. The options are successful or failed. |
| transactionReference | String | If you supplied a transactionReference, the same will be returned here. Else, we would generate a reference and return that to you in this field. |
| transactionDate | String | Date the transaction was done |
| searchParameter | String | TIN used for the verification |
| response | Json | This is a json containing all the actual TIN data as retrieved from the service provider. |
{
"responseCode": "00",
"description": "Successful",
"verificationType": "TIN-FULL-DETAIL-VERIFICATION",
"verificationStatus": "VERIFIED",
"transactionStatus": "SUCCESSFUL",
"transactionReference": "1630321373727-L6DFU0BX",
"transactionDate": "1659520798363",
"searchParameter": "00000000-0000",
"callBackUrl": null,
"livenessScore": 0.0,
"paymentRef": null,
"response": {
"typeofEntity": "00000000-0000",
"phoneNumber2": "Not Available",
"country": "NG",
"expiration_date": "Not Available",
"full_name": "SEAMFIX LTD",
"dob": "Not Available",
"photo": "Not Available",
"phone_number": "12345678900",
"phone_number2": "Not Available",
"document": "Not Available",
"gender": "Not Available",
"address": "Not Available",
"type_of_entity": "00000000-0000",
"tax_office": "Lagos",
"cac_reg_no": "BN0000000",
"email": "...",
"jittin": null,
"tin": "00000000-0000",
"tax_payer_name": "SEAMFIX LTD",
"phone_no": null,
"id_number": "00000000-0000"
},
"faceMatch": null
}
Updated 10 months ago