Tax Identification Number (TIN) Verification

This endpoint allows you to validate the Tax Identification Number of different businesses.

TIN Verification

POST {{baseurl}}/v2/api/verifications/ng/tin

Headers

Name	Type	Description
token*	String	API secret token

Request Body

Name	Type	Description
tin*	String	Tax identificiation number of the business
isSubjectConsent*	Boolean	Indicate subject has given consent. Must be true

TIN Verification Sample Request

{
    "tin": "00000000-0000",
    "isConsent": true
}

Sample Success Response

{
      "success": true,
      "statusCode": 200,
      "message": "success",
      "data": {
          "id": "62663af982b204577a58dd9c",
          "status": "found",
          "businessId": "61d880f1e8e15aaf24558f1a",
          "parentId": null,
          "isConsent": true,
          "type": "tin-lookup",
          "name": "JOHN DOE LTD",
          "registrationNumber": "RC00000000",
          "tin": "00000000-0000",
          "jtbTin": "0000000000",
          "taxOffice": "MSTO ILUPEJU I",
          "email": "[e-mail]",
          "phone": "08000000000",
          "requestedAt": "2022-04-25T06:08:57.670Z",
          "createdAt": "2022-04-25T06:08:57.845Z",
          "requestedBy": {
              "firstName": "API",
              "lastName": "User",
              "middleName": "",
              "id": "61d880f2e8e15aaf24558f9b"
          }
      },
      "links": []
  }

Sample Failed Response

{
      "success": true,
      "statusCode": 200,
      "message": "success",
      "data": {
          "id": "626636002c1fbe4da972a50d",
          "status": "not_found",
          "businessId": "61d880f1e8e15aaf24558f1a",
          "parentId": null,
          "isConsent": true,
          "type": "tin-lookup",
          "name": null,
          "registrationNumber": null,
          "tin": "20504133-0002",
          "jtbTin": null,
          "taxOffice": null,
          "email": null,
          "phone": null,
          "requestedAt": "2022-04-25T05:47:46.398Z",
          "createdAt": "2022-04-25T05:47:46.782Z",
          "requestedBy": {
              "firstName": "API",
              "lastName": "User",
              "middleName": "",
              "id": "61d880f2e8e15aaf24558f9b"
          }
      },
      "links": []
  }

Error Response

{
  "success": false,
  "statusCode": 404,
  "message": "You have attempted to get a resource that does not exist.",
  "name": "ResourceNotFoundError",
  "data": {}
}