Customize Consent Preferences

We use cookies to help you navigate efficiently and perform certain functions. You will find detailed information about all cookies under each consent category below.

The cookies that are categorized as "Necessary" are stored on your browser as they are essential for enabling the basic functionalities of the site. ... 

Always Active

Necessary cookies are required to enable the basic features of this site, such as providing secure log-in or adjusting your consent preferences. These cookies do not store any personally identifiable data.

Functional cookies help perform certain functionalities like sharing the content of the website on social media platforms, collecting feedback, and other third-party features.

Analytical cookies are used to understand how visitors interact with the website. These cookies help provide information on metrics such as the number of visitors, bounce rate, traffic source, etc.

Performance cookies are used to understand and analyze the key performance indexes of the website which helps in delivering a better user experience for the visitors.

Advertisement cookies are used to provide visitors with customized advertisements based on the pages you visited previously and to analyze the effectiveness of the ad campaigns.

Other uncategorized cookies are those that are being analyzed and have not been classified into a category as yet.

Skip to main content

Get a list of required onboarding documents

Get a list of required supporting documents for your onboarding using the API. Add information about collecting supporting documents to the success payload when creating an onboarding link.

Empty list

The mutation might return an empty list of required documents. This is expected behavior, meaning no supporting documents are required for this onboarding at this time.

Guide​

  1. Create your onboarding link for an individual or a company.
  2. Add the supportingDocumentCollection field and the requiredSupportingDocumentPurposes subfield to the success payload. You might also choose to add collection status info.

Mutation​

Partial mutation

Add this information to the full mutation when creating an individual or company onboarding link. Note that the example features company onboarding.

mutation ListRequiredDocuments {
onboardCompanyAccountHolder {
{...}
... on OnboardCompanyAccountHolderSuccessPayload {
__typename
onboarding {
id
onboardingState
statusInfo {
status
}
supportingDocumentCollection {
requiredSupportingDocumentPurposes {
acceptableSupportingDocumentTypes
name
}
statusInfo {
status
}
}
}
}
{...}
}
}

Payload​

Review this full success payload for a company account holder onboarding.

Notice the documents listed (lines 11-23), as well as the collection status WaitingForDocument (line 27).

{
"data": {
"onboardCompanyAccountHolder": {
"__typename": "OnboardCompanyAccountHolderSuccessPayload",
"onboarding": {
"id": "$ONBOARDING_ID",
"onboardingState": "Ongoing",
"statusInfo": {
"status": "Valid"
},
"supportingDocumentCollection": {
"requiredSupportingDocumentPurposes": [
{
"acceptableSupportingDocumentTypes": [
"UBODeclaration"
],
"name": "UBODeclaration"
},
{
"acceptableSupportingDocumentTypes": [
"SwornStatement"
],
"name": "SwornStatement"
}
],
"statusInfo": {
"status": "WaitingForDocument"
}
}
}
}
}
}