Sandbox HOST URL: https://sandbox.compliancely.com/
We have simulated a few inputs for each possible response type. Any other input provided may give a pending result with irs_code as -1.
Note: Requests are not stored. Hence you have to use the same set (request ids) as in the response object to simulate the GET API. All the data sample combinations used are dummy and just used for simulation purpose.
Note: Webhooks will not function on sandbox requests. Same response object format of POST / GET API call will be sent in the body of webhook request.
All the examples are given in the curl notation
curl --location -g --request POST '{{url}}/api/v1/submissions/' \
--header 'Authorization: Token {{token}}' \
--header 'Content-Type: application/json' \
--data-raw '{
"tin": "$tin",
"name": "$name",
“webhook_urls”: [“$url”]
}'
Sample responses for various IRS Codes:
To simulate irs_code as 3
{
"name": "Zenwork",
"tin": "111232312"
}
{
"id": 4989258,
"name": "Zenwork",
"tin": "111232312",
"status": "Did Not Match",
"created_by": "compliancely",
"irs_code": 3,
"irs_reason": "TIN and Name combination does not match IRS records.",
"irs_service_status": "RUNNING",
"last_irs_check_date": "2023-02-20T18:02:33Z",
"created_date": "2023-02-20T18:02:33Z",
"updated_date": "2023-02-20T18:02:33Z"
}
{
"name": "Name Name",
"tin": "112233445"
}
{
"id": 4864421,
"name": "Name Name",
"tin": "112233445",
"status": "Did Not Match",
"created_by": "compliancely",
"irs_code": 3,
"irs_reason": "TIN and Name combination does not match IRS records.",
"irs_service_status": "RUNNING",
"last_irs_check_date": "2023-01-21T22:00:24Z",
"created_date": "2023-02-20T18:02:33Z",
"updated_date": "2023-01-21T22:00:24Z"
}
To simulate irs_code as -1
{
"name": "Media Zenwork",
"tin": "111232314"
}
{
"id": 4989260,
"name": "Media Zenwork",
"tin": "111232314",
"status": "Pending",
"created_by": "compliancely",
"irs_code": -1,
"irs_reason": "",
"irs_service_status": "THE IRS TIN MATCHING SERVICE IS SLOW OR CURRENTLY EXPERIENCING AN OUTAGE",
"last_irs_check_date": "2023-02-06T09:10:45Z",
"created_date": "2023-02-06T09:10:45Z",
"updated_date": "2023-02-06T09:10:45Z"
}
To simulate irs_code as 0
{
"name": "Zenwork PVT LTD",
"tin": "111232315"
}
{
"id": 4989261,
"name": "Zenwork PVT LTD",
"tin": "111232315",
"status": "TIN Matched",
"created_by": "compliancely",
"irs_code": 0,
"irs_reason": "TIN and Name combination matches IRS records.",
"irs_service_status": "RUNNING",
"last_irs_check_date": "2023-02-06T09:10:45Z",
"created_date": "2023-02-06T09:10:45Z",
"updated_date": "2023-02-06T09:10:45Z"
}
To simulate irs_code as 1
{
"name": "Inc Zenwork",
"tin": "221232316"
}
{
"id": 4989253,
"name": "Inc Zenwork",
"tin": "221232316",
"status": "Did Not Match",
"created_by": "compliancely",
"irs_code": 1,
"irs_reason": "TIN was missing or TIN not 9-digit numeric.",
"irs_service_status": "RUNNING",
"last_irs_check_date": "2023-02-06T09:10:45Z",
"created_date": "2023-02-06T09:10:45Z",
"updated_date": "2023-02-06T09:10:45Z"
}
To simulate irs_code as 2
{
"name": "Zenwork Digital",
"tin": "221232315"
}
{
"id": 4989254,
"name": "Zenwork Digital",
"tin": "221232315",
"status": "Did Not Match",
"created_by": "compliancely",
"irs_code": 2,
"irs_reason": "TIN entered is not currently issued.",
"irs_service_status": "RUNNING",
"last_irs_check_date": "2023-02-06T09:10:45Z",
"created_date": "2023-02-06T09:10:45Z",
"updated_date": "2023-02-06T09:10:45Z"
}
To simulate irs_code as 6
{
"name": "Zenwork LTD",
"tin": "111232316"
}
{
"id": 4989262,
"name": "Zenwork LTD",
"tin": "111232316",
"status": "TIN Matched",
"created_by": "compliancely",
"irs_code": 6,
"irs_reason": "TIN and Name combination matches IRS SSN records.",
"irs_service_status": "RUNNING",
"last_irs_check_date": "2023-02-06T09:10:45Z",
"created_date": "2023-02-06T09:10:45Z",
"updated_date": "2023-02-06T09:10:45Z"
}
To simulate irs_code as 7
{
"name": "Zenwork Co",
"tin": "111232317"
}
{
"id": 4989263,
"name": "Zenwork Co",
"tin": "111232317",
"status": "TIN Matched",
"created_by": "compliancely",
"irs_code": 7,
"irs_reason": "TIN and Name combination matches IRS EIN records.",
"irs_service_status": "RUNNING",
"last_irs_check_date": "2023-02-06T09:10:45Z",
"created_date": "2023-02-06T09:10:45Z",
"updated_date": "2023-02-06T09:10:45Z"
}
To simulate irs_code as 8
{
"name": "Zenwork Compliancely",
"tin": "111232318"
}
{
"id": 4989264,
"name": "Zenwork Compliancely",
"tin": "111232318",
"status": "TIN Matched",
"created_by": "compliancely",
"irs_code": 8,
"irs_reason": "TIN and Name combination matches IRS SSN and EIN records.",
"irs_service_status": "RUNNING",
"last_irs_check_date": "2023-02-06T09:10:45Z",
"created_date": "2023-02-06T09:10:45Z",
"updated_date": "2023-02-06T09:10:45Z"
}
To simulate irs_code as 10
{
"name": "Zenwork Limited",
"tin": "221232310"
}
{
"id": 4989256,
"name": "Zenwork Limited",
"tin": "221232310",
"status": "In Review",
"created_by": "compliancely",
"irs_code": 10,
"irs_reason": "Duplicate/Invalid record - We're reviewing the information.",
"irs_service_status": "RUNNING",
"last_irs_check_date": "2023-02-06T09:10:45Z",
"created_date": "2023-02-06T09:10:45Z",
"updated_date": "2023-02-06T09:10:45Z"
}
{
"name": "Zenwork Services",
"tin": "221232314"
}
{
"id": 4989255,
"name": "Zenwork Services",
"tin": "221232314",
"status": "In Review",
"created_by": "compliancely",
"irs_code": 10,
"irs_reason": "Duplicate/Invalid record - We're reviewing the information.",
"irs_service_status": "THE IRS TIN MATCHING SERVICE IS SLOW OR CURRENTLY EXPERIENCING AN OUTAGE",
"last_irs_check_date": "2023-02-06T09:10:45Z",
"created_date": "2023-02-06T09:10:45Z",
"updated_date": "2023-02-06T09:10:45Z"
}
Simulation for validation errors:
{
"name": "Name Name",
"tin": "11223344"
}
{
"tin": [
"TIN format is invalid/ TIN must be 9 digits"
]
}
{
"name": "Name Name",
"tin": "1122334457"
}
{
"tin": [
"TIN format is invalid/ TIN must be 9 digits",
"Ensure this field has no more than 9 characters."
]
}
Simulation for validation errors:
{
"name": "Name Name",
"tin": ""
}
{
"tin": [
"This field may not be blank."
]
}
{
"name": "Name Name"
}
{
"tin": [
"This field is required."
]
}
Simulation for validation errors:
{
"name": "",
"tin": "112233445"
}
{
"name": [
"This field may not be blank."
]
}
{
"tin": "112233445"
}
{
"name": [
"This field is required."
]
}
Simulation for validation errors:
{
"name": "Name Name Name Name Name Name Name Name Name Name",
"tin": "112233445"
}
{
"name": [
"Ensure this field has no more than 40 characters."
]
}
GET method Simulation:
Response for requesting records by id: api/v1/submissions/4864421/
{
"id": 4864421,
"name": "Name Name",
"tin": "112233445",
"status": "Did Not Match",
"created_by": "compliancely",
"irs_code": 3,
"irs_reason": "TIN and Name combination does not match IRS records.",
"irs_service_status": "RUNNING",
"last_irs_check_date": "2023-01-10T02:07:55Z",
"created_date": "2023-02-01T13:31:07Z",
"updated_date": "2023-01-10T02:07:55Z"
}
Response when the data for the requested id is not present: api/v1/submissions/1/
{
"detail": "Not found."
}