Tax Exempt Search

This endpoint will be used to submit Tax Exempt check request which requires tin or name as a required argument.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Request and Response Object Structures.

Either TIN or Name is mandatory in the post body.

{
    "tin": string, /*Either TIN or Name is Mnadatory*/
    "name": string, /*Either TIN or Name is Mandatory*/
    "webhook_urls": [string]
}
{
    "success_message": string,
    "data": {
        "id": integer,
        "tin": string,
        "name": string,
        "status": string,
        "created_at": string,
        "created_by": string,
        "webhook_urls": Array
    },
    "success": boolean
}

Sample Requests and Responses.

{
    "tin": "111232312",
    "webhook_urls": []
}
{
    "success_message": "Created new TAX Exempt record",
    "data": {
        "id": 297,
        "tin": "123456789",
        "name": "",
        "status": "Pending",
        "created_at": "2024-07-08T12:36:56.401518Z",
        "created_by": "compliancely",
        "webhook_urls": []
    },
    "success": true
}
{
    "errors": [
        {
            "code": "tin",
            "message": "Please enter valid TIN/EIN"
        }
    ],
    "data": null,
    "success": false
}
{
    "errors": [
        {
            "code": "name",
            "message": "You have entered invalid characters in the Name field. Search terms in the Name field can only include letters, numbers, @, /, \\, &, %, (), *, hyphens, spaces, apostrophes, periods, commas and quotation marks."
        }
    ],
    "data": null,
    "success": false
}
{
    "detail": "Authentication credentials were not provided."
}
{
    "detail": "Credit limit reached! For assistance, please contact the support"
}
{
    "detail": "Invalid token."
}
Body Params
string
length ≥ 1

Enter TIN

string
length ≥ 1

Enter Name

webhook_urls
array of strings

Please enter the URLs where you would like to receive webhook notifications

webhook_urls
Responses

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json