Document purposes and types

For all supporting documents, there is a high-level purpose and a more specific type (supportingDocumentPurpose and supportingDocumentType). Both purpose and type can be exposed in the onboarding success payload.

Common purposes

Common purposes include:

• CompanyRegistration
• SignedStatus
• ProofOfIndividualAddress and ProofOfCompanyAddress
• ProofOfIndividualIncome and ProofOfCompanyIncome
• ProofOfBusinessActivity
• USPersonStatusDeclaration
• Other

purposeDetails for Other purposes

purposeDetails is an optional field available on the SupportingDocumentPurpose type (returned under requiredSupportingDocumentPurposes).

When the requested purpose is Other, purposeDetails contains free-text details that specify what supporting document is required (for example, "Company structure chart").

For standard purposes (predefined purposes with a specific meaning, such as ProofOfIndividualAddress or CompanyRegistration), purposeDetails is null.

Document types

Types are the specific documents that can fulfill a purpose. Each purpose accepts a set of types, returned in the acceptableSupportingDocumentTypes field. For all possible values, refer to the SupportingDocumentType enum in the API Reference.