Get a list of required documents

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

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"
          }
        }
      }
    }
  }
}