Documentation Index
Fetch the complete documentation index at: /docs/llms.txt
Use this file to discover all available pages before exploring further.
To retrieve the government-issued identification number of a business’ proprietor, send a GET request to the /businesses//ssn endpoint.
GET request to the /businesses/{token}/ssn endpoint. Include the token path parameter to specify the business whose identification number (SSN, ITIN, TIN, NIN, SIN) you want to return. You can indicate whether to return the full number or the last four digits only.
| Fields | Description |
|---|---|
| token string Required | Unique identifier of the business resource. Allowable Values: Existing business resource token |
| Fields | Description |
|---|---|
| full_ssn boolean Optional | To return the full identification number, set to true. To return only the last four digits, set to false. If the proprietor_or_officer.identifications array contains only the last four digits of the identification number, the /businesses/{token}/ssn endpoint will return only the last four digits regardless of the full_ssn parameter.Allowable Values: true, false |
| Fields | Description |
|---|---|
| nin string Conditionally returned | National Identification Number (NIN). Allowable Values: 255 char max |
| sin string Conditionally returned | Social Insurance Number (SIN). Allowable Values: 255 char max |
| ssn string Conditionally returned | Social Security Number (SSN) or Individual Taxpayer Identification Number (ITIN). Allowable Values: 255 char max |
| tin string Conditionally returned | Taxpayer Identification Number (TIN). Allowable Values: 255 char max |
{
"ssn": "5555"
}
Was this page helpful?