GuidesReferenceChangelogAPI Upgrades
Reference

The requirement object

Represents the data or documentation required from a company to perform certain actions, such as run payroll or file quarterly tax returns.

Use the requirement object to show the documentation or data input needed from end-users in order to perform certain actions, such as run payroll or file quarterly tax returns.

{
    "id": "req_lmdjesylstq2h0xwhftm",
    "company": "com_yvgimu7i60cwfod0jhaft",
    "requirement": "company_identity_verification",
    "categories": ["company_provided_documents"],
    "status": "open",
    "errors": [],
    "guidance": {
        "document_options": [
            {
                "name": "articles_of_incorporation",
                "label": "Articles of Incorporation (Company registration document)",
            },
            {
                "name": "bank_statement",
                "label": "Full bank statement including bank name, account number, and acount owner's name and address",
            },
        ],
        "funding_detail": null
    },
}
AttributeDescription
id
string 		Unique identifier for the requirement.
company
string		Unique identifier for the company.
requirement
string		Name identifying the requirement.
categories
list		List representation of the different categorizations of requirements.

See Requirement categories.
status
string		Status of the requirement in its lifecycle.

One of open, pending, resolved, failed, or closed.
errors
list		Errors flagged by Check during review of the provided documentation or information. These errors will be surfaced alongside the requirement status document_rejected.

See Requirement Errors object.
guidance
object		Guidance on how to fulfill the requirement. For example, for documentation requests, document_options will be listed within the guidance object.

See Requirement Guidance.