Business Verification US - Retrieve
Overview & Purpose
This API serves as a fallback option for users encountering difficulties retrieving information through the Business Verification API. Typically, users receive the completed business report asynchronously on their callback URL after submitting through the Business Verification API. However, in instances where this direct retrieval is unsuccessful β for example, when no callback URL was provided or the callback was not received β this API acts as a backup solution. It ensures that users can still obtain relevant information about the specified business on demand by supplying the unique businessId, even without providing a callback URL for receiving the response. Essentially, it offers a fail-safe mechanism, ensuring users have access to vital business data when encountering retrieval challenges through the primary API. The output for this API is the same as the primary API.
Note: Verification runs asynchronously. Immediately after creation the status is typically open / in_review. You can call this endpoint with the businessId at any time to fetch the latest state; until the report is ready, businessReport may return "PDF is not ready".
API Details
Business verification Retrieve API
API Input
curl --location 'https://api.signzy.us/api/v3/us-kyb/business-verification-retrieve-us' \
--header 'Authorization: < auth_token >' \
--header 'Content-Type: application/json' \
--data-raw '{
"businessId": "<business_request_id>"
}'API Input Mapping
Field | Type | Required/Optional | Description |
|---|---|---|---|
businessId | string | Required | The unique business identifier returned by the Create Business API. Used to retrieve all information about the company. |
API Response
{
"result": {
"object": "business",
"businessId": "<business_request_id>",
"name": "<Company Name>",
"status": "in_review",
"documents": [],
"businessReport": "<persist url>",
"names": [],
"addresses": [],
"assigneeId": "",
"supportedDocumentTypes": [],
"review": {},
"tin": {},
"businessBatchId": "",
"formation": {},
"website": {},
"watchlist": {},
"bankruptcies": [],
"liens": [],
"people": [],
"phoneNumbers": [],
"profiles": [],
"registrations": [],
"industryClassification": "",
"fmcsaRegistrations": [],
"litigations": [],
"actions": [],
"policyResults": [],
"submitted": {}
}
}API Output Mapping
Field | Data Type | Description |
|---|---|---|
object | String | Refers to the object type, always "business". |
businessId | String | The unique ID used in the request to retrieve the data. |
name | String | The registered business name the data is being retrieved for. |
status | String | Status of the verification request (e.g. open, in_review, completed). |
documents | Array | List of supported documents with downloadable (persist) URLs. |
businessReport | String | Downloadable URL for the business PDF report. Returns "PDF is not ready" until generation completes. |
names | Array | Activity status of the company across the jurisdictions where it operates. |
addresses | Array | Addresses associated with the company. |
assigneeId | String | Internal assignee identifier for the review, if any. |
supportedDocumentTypes | Array | Document types available to order/download for this business. |
review | Object | Review details β watchlist, watchlist source, SOS activity, addresses, people. |
tin | Object | TIN verification details (verified / mismatch / unknown / issued flags), when TIN was ordered. |
businessBatchId | String | Batch identifier associated with the business submission. |
formation | Object | Formation/incorporation details, including entity type. |
website | Object | Website analysis, including page screenshots (persist URLs). |
watchlist | Object | Watchlist information the company was screened against, with source. |
bankruptcies | Array | Bankruptcy records associated with the company. |
liens | Array | UCC / tax lien records, including downloadable lien documents. |
people | Array | Key people holding positions in the company. |
phoneNumbers | Array | Phone numbers associated with the company. |
profiles | Array | Related business profiles. |
registrations | Array | Registered offices and officers holding positions in the company. |
industryClassification | String | Industry classification of the company. |
fmcsaRegistrations | Array | Registrations with the Federal Motor Carrier Safety Administration (FMCSA). |
litigations | Array | Litigation records associated with the company. |
actions | Array | Actions performed / available on the business record. |
policyResults | Array | Results of any applied verification policies. |
submitted | Object | Confirmation of the basic information submitted in the Create Business input (address and orders placed). |
Error Code Response & Mapping
{
"error": {
"name": "error",
"message": "Data not found for the given input",
"status": "404",
"reason": "ERROR",
"type": "Not Found",
"statusCode": 200
}
}Field | Type | Description |
|---|---|---|
name | string | Text displayed on the screen explaining error type. |
reason | string | Reason for the error. |
status | number | HTTP status code. |
message | string | Error message indicating an upstream error. |
type | string | Error type. |
statusCode | string | Status code representing the error scenario. |
Getting help
Please feel free to contact us if you have any questions, require clarification, or have ideas for how to make the documents or any of our services better.
You can reach out to us at [email protected]. We strive to provide prompt and reliable assistance, ensuring your queries are addressed effectively.
We value your feedback and are committed to making your experience smooth and enjoyable. Our team is dedicated to assisting you with any needs you may have. Thank you for choosing our services. We look forward to helping you!