Browse the API30

bank-link

get

/api/v1/bank-link/{id}/status

The state of one bank-verification request, plus the account summary it produced.

Scope: cases:read
Rate limit: 200 requests / min
Idempotency: read-only

Authentication

Send your key as Authorization: Bearer …. It must carry the scope cases:read; a key without it receives 403 forbidden.

Path parameters

idstringrequired

Request body

This operation takes no request body.

Response

200application/jsonSerializedBankLinkStatus

link_idstringrequired

case_idstringrequired

statusstringrequired

created_atstring | nullrequirednullable

opened_atstring | nullrequirednullable

connected_atstring | nullrequirednullable

expires_atstring | nullrequirednullable

bank_connectedbooleanrequired

institutionstring | nullrequirednullable

account_typestring | nullrequirednullable

account_last4string | nullrequirednullable

accountsnumberrequired

1 when a bank account is connected, otherwise 0. A case holds at most one linked account.

analysisobject | nullrequirednullable

Errors

The statuses this operation can return, with the error.code values behind each. Every error body is the shared envelope described under Errors in Getting started.

401unauthorized

403forbidden

404not_found

429rate_limit_exceeded

500internal_error

Request

curl -X GET "https://<your-host>/api/v1/bank-link/<id>/status" \
  -H "Authorization: Bearer hlh_test_YOUR_API_KEY"

Response200application/json

{
  "link_id": string,
  "case_id": string,
  "status": string,
  "created_at": string | null,
  "opened_at": string | null,
  "connected_at": string | null,
  "expires_at": string | null,
  "bank_connected": boolean,
  "institution": string | null,
  "account_type": string | null,
  "account_last4": string | null,
  "accounts": number,
  "analysis": object
}

Shown as types, not sample values. A field typed number | null can be null; the response fields table gives the reason.