Get collection or document information using the API

Get information about a supporting document collection or an individual document with the API, for a transaction or an account onboarding.

Transaction documents

Get information about a collection or document related to a transaction with the API.

Collect documents with the API

You can only call the API to get information about supporting documents for transactions if you collect documents with the API.

API

1. First, retrieve the required transaction ID.
2. Call the transaction query.
3. Enter the transaction ID retrieved in step 1 (line 2).
4. Include purposeDetails under requiredSupportingDocumentPurposes to see what's needed if the purpose is Other (line 14).
5. Add all other objects you need to review. For example, SupportingDocumentRefusedStatusInfo (lines 19-25) to get refusal details.

Query

Open in API Explorer

query getTransactionCollectionInfo {
  transaction(id: "$TRANSACTION_ID") {
    ... on SEPACreditTransferTransaction {
      id
      supportingDocumentCollections {
        edges {
          node {
            statusInfo {
              status
            }
            id
            requiredSupportingDocumentPurposes {
              name
              purposeDetails
            }
            supportingDocuments {
              statusInfo {
                status
                ... on SupportingDocumentRefusedStatusInfo {
                  __typename
                  reasonCode
                  reason
                  refusedAt
                  status
                  filename
                }
              }
            }
          }
        }
      }
    }
  }
}

Payload

In this example, the collection status is WaitingForDocument (line 10). The required document purpose is ProofOfOriginOfFunds (line 15). purposeDetails is null here because this is a standard purpose (line 16).

{
  "data": {
    "transaction": {
      "id": "$TRANSACTION_ID",
      "supportingDocumentCollections": {
        "edges": [
          {
            "node": {
              "statusInfo": {
                "status": "WaitingForDocument"
              },
              "id": "$COLLECTION_ID",
              "requiredSupportingDocumentPurposes": [
                {
                  "name": "ProofOfOriginOfFunds",
                  "purposeDetails": null
                }
              ],
              "supportingDocuments": [
                {
                  "statusInfo": {
                    "status": "WaitingForUpload"
                  }
                }
              ]
            }
          }
        ]
      }
    }
  }
}

Onboarding documents

Get information about a collection or document related to an account onboarding with the API.

API

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, either with the API or from your Dashboard > Data > Onboardings.
2. Call the accountHolderOnboarding query.
3. Enter the onboarding ID retrieved in step 1 (line 2).
4. Include purposeDetails under requiredSupportingDocumentPurposes to see what's needed if the purpose is Other (line 8).
5. Add all other objects you need to review.
   • Example: add supportingDocumentPurpose to know which supporting document is required (line 11).
   • Example: add supportingDocuments > statusInfo > status (lines 14-15) to retrieve the document's status.
   • Example: add SupportingDocumentRefusedStatusInfo and its fields (lines 16-22) to get information about why a document was Refused.

Account holder ID

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

Query

Open in API Explorer

query getOnboardingCollectionInfo {
  accountHolderOnboarding(id: "$ONBOARDING_ID") {
    ... on IndividualAccountHolderOnboarding {
      supportingDocumentCollection {
        id
        requiredSupportingDocumentPurposes {
          name
          purposeDetails
        }
        supportingDocuments {
          supportingDocumentPurpose
          supportingDocumentType
          updatedAt
          statusInfo {
            status
            ... on SupportingDocumentRefusedStatusInfo {
              __typename
              filename
              reason
              reasonCode
              refusedAt
              status
            }
          }
        }
      }
    }
    ... on CompanyAccountHolderOnboarding {
      supportingDocumentCollection {
        id
        requiredSupportingDocumentPurposes {
          name
          purposeDetails
        }
        supportingDocuments {
          supportingDocumentPurpose
          supportingDocumentType
          updatedAt
          statusInfo {
            status
            ... on SupportingDocumentRefusedStatusInfo {
              __typename
              filename
              reason
              reasonCode
              refusedAt
              status
            }
          }
        }
      }
    }
  }
}

Payload: Validated

In this example, the required document purpose is Other (line 8). purposeDetails is "Most recent business income tax return (aangifte inkomstenbelasting)" (line 9). The document was received, reviewed, and Validated (line 18).

{
  "data": {
    "accountHolderOnboarding": {
      "supportingDocumentCollection": {
        "id": "$COLLECTION_ID",
        "requiredSupportingDocumentPurposes": [
          {
            "name": "Other",
            "purposeDetails": "Most recent business income tax return (aangifte inkomstenbelasting)"
          }
        ],
        "supportingDocuments": [
          {
            "supportingDocumentPurpose": "Other",
            "supportingDocumentType": null,
            "updatedAt": "2026-04-16T08:37:47.625Z",
            "statusInfo": {
              "status": "Validated"
            }
          }
        ]
      }
    }
  }
}

Payload: Refused

In this example, the required document purpose is UBODeclaration (line 8). The document was Refused (line 18) with reason code InvalidDocument (line 22). purposeDetails is null here because this is a standard purpose (line 9).

{
  "data": {
    "accountHolderOnboarding": {
      "supportingDocumentCollection": {
        "id": "$COLLECTION_ID",
        "requiredSupportingDocumentPurposes": [
          {
            "name": "UBODeclaration",
            "purposeDetails": null
          }
        ],
        "supportingDocuments": [
          {
            "supportingDocumentPurpose": "UBODeclaration",
            "supportingDocumentType": "UBODeclaration",
            "updatedAt": "2026-04-14T15:16:48.507Z",
            "statusInfo": {
              "status": "Refused",
              "__typename": "SupportingDocumentRefusedStatusInfo",
              "filename": "file_name.pdf",
              "reason": "",
              "reasonCode": "InvalidDocument",
              "refusedAt": "2026-04-14T15:16:48.507Z"
            }
          }
        ]
      }
    }
  }
}