Get account holder verification status using the API

Call the accountHolder query to get an account holder's verification status. Add verificationStatusInfo to get more details about specific statuses. This guide gives more details about an account holder verification with the status WaitingForInformation.

Guide

1. First, retrieve the required accountHolderId: on your Dashboard, go to Data > Account holders, locate the account holder you need, and click to copy their ID.
2. Call the accountHolder query.
3. Enter the accountHolderId retrieved in step 1.
4. Add the verificationStatusInfo object.
5. Add the AccountHolderWaitingForInformationVerificationStatusInfo union to get information about the WaitingForInformation status for this account holder verification.
6. Add verificationRequirements > id and type.

verificationRequirements

Review possible verificationRequirements in the waiting for information requirements.

Query

Open in API Explorer

query WaitingForInfoStatus {
  accountHolder(id: "$ACCOUNT_HOLDER_ID") {
    verificationStatusInfo {
      status
      ... on AccountHolderWaitingForInformationVerificationStatusInfo {
        __typename
        waitingForInformationAt
        status
        verificationRequirements {
          id
          type
        }
      }
    }
  }
}

Payload

Note the two verification requirements needed from this account holder (lines 11, 15).

{
  "data": {
    "accountHolder": {
      "verificationStatusInfo": {
        "status": "WaitingForInformation",
        "__typename": "AccountHolderWaitingForInformationVerificationStatusInfo",
        "waitingForInformationAt": "2024-10-29T13:56:38.972Z",
        "verificationRequirements": [
          {
            "id": "$VERIFICATION_REQUIREMENT_ID_1",
            "type": "FirstTransferRequired"
          },
          {
            "id": "$VERIFICATION_REQUIREMENT_ID_2",
            "type": "LegalRepresentativeDetailsRequired"
          }
        ]
      }
    }
  }
}