Get information about a collection or document

There are two methods you can use to get information about a collection or a document.

1. Run an API query to get information about collections and documents.
2. Get information about individual documents from your Dashboard.

API guide

You can use either the user's onboarding ID or, if their onboarding is Finalized, their account holder ID, to get information about a supporting document collection or an individual document.

1. First, retrieve the required onboarding ID.
2. Call the onboarding query.
3. Enter the onboarding ID retrieved in step 1.
4. Add all objects you need to review.
   • In the following example, refer to the highlighted lines to check the account holder ID, review when the document was last updated (updatedAt), and collect information about document status.

Onboarding or account holder ID

This guide uses the onboarding ID. If the onboarding is Finalized, use the accountHolder query to get the account holder ID instead.

Query

🔎 Open the query in API Explorer

query getCollectionInfo {
  supportingDocumentCollection(id: "$SUPPORTING_DOCUMENT_COLLECTION_ID") {
    id
    updatedAt
    accountHolder {
      id
    }
    onboarding {
      id
    }
    supportingDocuments {
      createdAt
      id
      supportingDocumentPurpose
      supportingDocumentType
      updatedAt
      statusInfo {
        status
        ... on SupportingDocumentNotUploadedStatusInfo {
          __typename
          status
        }
        ... on SupportingDocumentRefusedStatusInfo {
          __typename
          downloadUrl
          filename
          reason
          refusedAt
          status
        }
        ... on SupportingDocumentUploadedStatusInfo {
          __typename
          downloadUrl
          filename
          status
        }
        ... on SupportingDocumentValidatedStatusInfo {
          __typename
          downloadUrl
          filename
          validatedAt
          status
        }
        ... on SupportingDocumentWaitingForUploadStatusInfo {
          __typename
          status
          upload {
            url
            fields {
              key
              value
            }
          }
        }
      }
    }
  }
}

Payload

In the payload, you learn that this user isn't an account holder yet (line 7).

Additionally, the document was last updated 2023-06-20 (line 18) with the status Uploaded (line 20).

{
  "data": {
    "supportingDocumentCollection": {
      "id": "$SUPPORTING_DOCUMENT_COLLECTION_ID",
      "updatedAt": "2023-12-18T10:47:58.591Z",
      "accountHolder": {
        "id": null
      },
      "onboarding": {
        "id": "$ONBOARDING_ID"
      },
      "supportingDocuments": [
        {
          "createdAt": "2023-06-20T14:33:40.780Z",
          "id": "$DOCUMENT_ID",
          "supportingDocumentPurpose": "ProofOfIdentity",
          "supportingDocumentType": "Passport",
          "updatedAt": "2023-06-20T14:33:45.255Z",
          "statusInfo": {
            "status": "Uploaded",
            "__typename": "SupportingDocumentUploadedStatusInfo",
            "downloadUrl": "",
            "filename": "Passport"
          }
        }
      ]
    }
  }
}

Dashboard

Use the Dashboard to review information about a document.

1. Go to Data > Onboardings.
2. Open an onboarding, then go to Supporting documents.
3. Review all available information about your documents.