Get collection and document IDs

Retrieve the IDs of a supporting document collection and its documents: the inputs most document operations require.

Get a collection ID

Get the ID for the supporting document collection using either the user's onboarding ID or, if their onboarding is Finalized, their account holder ID.

Onboarding ID

Get a collection ID with the onboarding ID

Open in API Explorer

query getCollectionId {
  accountHolderOnboarding(id: "$USER_ONBOARDING_ID") {
    ... on IndividualAccountHolderOnboarding {
      supportingDocumentCollection {
        id
        requiredSupportingDocumentPurposes {
          name
        }
        statusInfo {
          status
        }
      }
    }
    ... on CompanyAccountHolderOnboarding {
      supportingDocumentCollection {
        id
        requiredSupportingDocumentPurposes {
          name
        }
        statusInfo {
          status
        }
      }
    }
  }
}

Account holder ID

Get a collection ID with the account holder ID

Open in API Explorer

query getCollectionId {
  accountHolder(id: "$USER_ACCOUNT_HOLDER_ID") {
    supportingDocumentCollections {
      edges {
        node {
          requiredSupportingDocumentPurposes {
            name
          }
          id
        }
      }
    }
  }
}

Get a document ID

Get the ID for the supporting document using either the user's onboarding ID or, if their onboarding is Finalized, their account holder ID.

Onboarding ID

Get a document ID with the onboarding ID

Open in API Explorer

query getDocumentId {
  accountHolderOnboarding(id: "$USER_ONBOARDING_ID") {
    ... on IndividualAccountHolderOnboarding {
      supportingDocumentCollection {
        supportingDocuments {
          id
          statusInfo {
            status
          }
        }
      }
    }
    ... on CompanyAccountHolderOnboarding {
      supportingDocumentCollection {
        supportingDocuments {
          id
          statusInfo {
            status
          }
        }
      }
    }
  }
}

Account holder ID

Get a document ID with the account holder ID

Open in API Explorer

query getDocumentId {
  accountHolder(id: "$USER_ACCOUNT_HOLDER_ID") {
    supportingDocumentCollections {
      edges {
        node {
          supportingDocuments {
            id
            statusInfo {
              status
            }
          }
        }
      }
    }
  }
}