List accounts

GET

accounts

curl "https://api.zquence.ai/v1/accounts?page=1&limit=20" \
  -H "x-api-key: $ZQUENCE_PUBLIC_KEY" \
  -H "x-api-secret: $ZQUENCE_SECRET_KEY"

curl "https://api.zquence.ai/v1/accounts?status=accepted&limit=50" \
  -H "x-api-key: $ZQUENCE_PUBLIC_KEY" \
  -H "x-api-secret: $ZQUENCE_SECRET_KEY"

curl "https://api.zquence.ai/v1/accounts?dateFrom=2026-06-01&dateTo=2026-06-30&limit=100" \
  -H "x-api-key: $ZQUENCE_PUBLIC_KEY" \
  -H "x-api-secret: $ZQUENCE_SECRET_KEY"

curl "https://api.zquence.ai/v1/accounts?environmentId=69f9b5fa0600ccbf9c677005&limit=20" \
  -H "x-api-key: $ZQUENCE_PUBLIC_KEY" \
  -H "x-api-secret: $ZQUENCE_SECRET_KEY"

{
  "data": [
    {
      "id": "6a25cdcc36bc6230704b5bce",
      "title": "123 Elm Street Escrow",
      "accountType": "real_estate",
      "status": "accepted",
      "buyer": {
        "id": "6a25cdac36bc6230704b5b59",
        "name": "James Carter",
        "email": "james.carter@example.com",
        "phone": "+447911123456",
        "accepted": true
      },
      "seller": {
        "id": "6a25cdac36bc6230704b5b60",
        "name": "Emily Thompson",
        "email": "emily.thompson@example.com",
        "phone": "+14155550193",
        "accepted": true
      },
      "timeline": [
        {
          "event": "Buyer invitation sent",
          "eventType": "sent",
          "timestamp": "2026-06-07T20:00:12.400Z"
        },
        {
          "event": "Buyer accepted invitation",
          "eventType": "accepted",
          "timestamp": "2026-06-07T20:15:00.000Z"
        }
      ],
      "archivedAt": null,
      "archivedBy": null,
      "createdAt": "2026-06-07T20:00:12.414Z",
      "updatedAt": "2026-06-07T20:15:00.000Z"
    },
    {
      "id": "6a25cdcc36bc6230704b5bcf",
      "title": "Acme Corporation Escrow",
      "accountType": "permanent",
      "status": "pending",
      "buyer": {
        "id": "6a25cdac36bc6230704b5b59",
        "name": "Acme Inc",
        "email": "contact@acme.example.com",
        "phone": "+14155550100",
        "accepted": false
      },
      "timeline": [
        {
          "event": "Customer invitation sent",
          "eventType": "sent",
          "timestamp": "2026-06-08T10:30:00.000Z"
        }
      ],
      "archivedAt": null,
      "archivedBy": null,
      "createdAt": "2026-06-08T10:30:00.000Z",
      "updatedAt": "2026-06-08T10:30:00.000Z"
    }
  ],
  "total": 2,
  "page": 1,
  "limit": 20,
  "totalPages": 1
}

{
  "statusCode": 403,
  "message": "Forbidden resource"
}

Results are scoped to the environment resolved from the authenticated API key. Live keys return live accounts; sandbox keys return sandbox accounts. Pass environmentId explicitly to query a specific environment. Party field naming: real_estate accounts return both buyer and seller fields. permanent and construction accounts return only a buyer field (representing the single customer).

Requires the transaction.view.all permission on the authenticated API key or role.

Query parameters

integer

default:"1"

Page number (1-indexed).

integer

default:"10"

Results per page. Maximum 100. Alias: page_size.

string

Filter by account type. Supported values: real_estate, permanent, construction.

string

Filter by account status. Supported values: invited, pending, accepted, completed.

string

Filter results to accounts in this specific environment. When provided, overrides the environment resolved from the API key.
Use the List environments endpoint to get valid environment IDs.

string

Free-text search on account title or account ID. Case-insensitive.

string

ISO 8601 date — return accounts created on or after this date (e.g. 2026-01-01).

string

ISO 8601 date — return accounts created on or before this date (e.g. 2026-12-31).

string

default:"false"

Controls archived visibility. false = active only, true = archived only, all = both.

Returns

A paginated response object.

array

Array of account summary objects for the current page.

number

Total accounts matching the query.

number

Current page number.

number

Page size in effect.

number

Total number of pages.

Each data entry includes:

string

Account ID (MongoDB ObjectId).

string

Account title as provided at creation.

string

"real_estate", "permanent", or "construction".

string

Current account status — see status values below.

object | null

For real_estate accounts: the buyer party. For permanent and construction: the single customer party. Fields: id, name, email, phone, accepted.

object | null

Only present for real_estate accounts. For other types this field is omitted. Fields: id, name, email, phone, accepted.

array

Ordered list of timeline events. Each entry has event, eventType, timestamp, and optional details.

string | null

ISO 8601 timestamp if the account has been archived. null otherwise.

string | null

User ID of the admin who archived it. null otherwise.

string

ISO 8601 UTC creation timestamp.

string

ISO 8601 UTC last-updated timestamp.

Account status values

Value	Description
`invited`	Account created, invitations sent — no party has accepted yet.
`pending`	At least one party has accepted; waiting on the remaining party.
`accepted`	All required parties accepted — document submission is open.
`completed`	Admin closed the account after all compliance requirements were verified.

Error codes

Status	Meaning
`401`	Missing or invalid API key pair.
`403`	Caller does not have `transaction.view.all` permission.

curl "https://api.zquence.ai/v1/accounts?page=1&limit=20" \
  -H "x-api-key: $ZQUENCE_PUBLIC_KEY" \
  -H "x-api-secret: $ZQUENCE_SECRET_KEY"

curl "https://api.zquence.ai/v1/accounts?status=accepted&limit=50" \
  -H "x-api-key: $ZQUENCE_PUBLIC_KEY" \
  -H "x-api-secret: $ZQUENCE_SECRET_KEY"

curl "https://api.zquence.ai/v1/accounts?dateFrom=2026-06-01&dateTo=2026-06-30&limit=100" \
  -H "x-api-key: $ZQUENCE_PUBLIC_KEY" \
  -H "x-api-secret: $ZQUENCE_SECRET_KEY"

curl "https://api.zquence.ai/v1/accounts?environmentId=69f9b5fa0600ccbf9c677005&limit=20" \
  -H "x-api-key: $ZQUENCE_PUBLIC_KEY" \
  -H "x-api-secret: $ZQUENCE_SECRET_KEY"

{
  "data": [
    {
      "id": "6a25cdcc36bc6230704b5bce",
      "title": "123 Elm Street Escrow",
      "accountType": "real_estate",
      "status": "accepted",
      "buyer": {
        "id": "6a25cdac36bc6230704b5b59",
        "name": "James Carter",
        "email": "james.carter@example.com",
        "phone": "+447911123456",
        "accepted": true
      },
      "seller": {
        "id": "6a25cdac36bc6230704b5b60",
        "name": "Emily Thompson",
        "email": "emily.thompson@example.com",
        "phone": "+14155550193",
        "accepted": true
      },
      "timeline": [
        {
          "event": "Buyer invitation sent",
          "eventType": "sent",
          "timestamp": "2026-06-07T20:00:12.400Z"
        },
        {
          "event": "Buyer accepted invitation",
          "eventType": "accepted",
          "timestamp": "2026-06-07T20:15:00.000Z"
        }
      ],
      "archivedAt": null,
      "archivedBy": null,
      "createdAt": "2026-06-07T20:00:12.414Z",
      "updatedAt": "2026-06-07T20:15:00.000Z"
    },
    {
      "id": "6a25cdcc36bc6230704b5bcf",
      "title": "Acme Corporation Escrow",
      "accountType": "permanent",
      "status": "pending",
      "buyer": {
        "id": "6a25cdac36bc6230704b5b59",
        "name": "Acme Inc",
        "email": "contact@acme.example.com",
        "phone": "+14155550100",
        "accepted": false
      },
      "timeline": [
        {
          "event": "Customer invitation sent",
          "eventType": "sent",
          "timestamp": "2026-06-08T10:30:00.000Z"
        }
      ],
      "archivedAt": null,
      "archivedBy": null,
      "createdAt": "2026-06-08T10:30:00.000Z",
      "updatedAt": "2026-06-08T10:30:00.000Z"
    }
  ],
  "total": 2,
  "page": 1,
  "limit": 20,
  "totalPages": 1
}

{
  "statusCode": 403,
  "message": "Forbidden resource"
}

curl "https://api.zquence.ai/v1/accounts?page=1&limit=20" \
  -H "x-api-key: $ZQUENCE_PUBLIC_KEY" \
  -H "x-api-secret: $ZQUENCE_SECRET_KEY"

curl "https://api.zquence.ai/v1/accounts?status=accepted&limit=50" \
  -H "x-api-key: $ZQUENCE_PUBLIC_KEY" \
  -H "x-api-secret: $ZQUENCE_SECRET_KEY"

curl "https://api.zquence.ai/v1/accounts?dateFrom=2026-06-01&dateTo=2026-06-30&limit=100" \
  -H "x-api-key: $ZQUENCE_PUBLIC_KEY" \
  -H "x-api-secret: $ZQUENCE_SECRET_KEY"

curl "https://api.zquence.ai/v1/accounts?environmentId=69f9b5fa0600ccbf9c677005&limit=20" \
  -H "x-api-key: $ZQUENCE_PUBLIC_KEY" \
  -H "x-api-secret: $ZQUENCE_SECRET_KEY"

{
  "data": [
    {
      "id": "6a25cdcc36bc6230704b5bce",
      "title": "123 Elm Street Escrow",
      "accountType": "real_estate",
      "status": "accepted",
      "buyer": {
        "id": "6a25cdac36bc6230704b5b59",
        "name": "James Carter",
        "email": "james.carter@example.com",
        "phone": "+447911123456",
        "accepted": true
      },
      "seller": {
        "id": "6a25cdac36bc6230704b5b60",
        "name": "Emily Thompson",
        "email": "emily.thompson@example.com",
        "phone": "+14155550193",
        "accepted": true
      },
      "timeline": [
        {
          "event": "Buyer invitation sent",
          "eventType": "sent",
          "timestamp": "2026-06-07T20:00:12.400Z"
        },
        {
          "event": "Buyer accepted invitation",
          "eventType": "accepted",
          "timestamp": "2026-06-07T20:15:00.000Z"
        }
      ],
      "archivedAt": null,
      "archivedBy": null,
      "createdAt": "2026-06-07T20:00:12.414Z",
      "updatedAt": "2026-06-07T20:15:00.000Z"
    },
    {
      "id": "6a25cdcc36bc6230704b5bcf",
      "title": "Acme Corporation Escrow",
      "accountType": "permanent",
      "status": "pending",
      "buyer": {
        "id": "6a25cdac36bc6230704b5b59",
        "name": "Acme Inc",
        "email": "contact@acme.example.com",
        "phone": "+14155550100",
        "accepted": false
      },
      "timeline": [
        {
          "event": "Customer invitation sent",
          "eventType": "sent",
          "timestamp": "2026-06-08T10:30:00.000Z"
        }
      ],
      "archivedAt": null,
      "archivedBy": null,
      "createdAt": "2026-06-08T10:30:00.000Z",
      "updatedAt": "2026-06-08T10:30:00.000Z"
    }
  ],
  "total": 2,
  "page": 1,
  "limit": 20,
  "totalPages": 1
}

{
  "statusCode": 403,
  "message": "Forbidden resource"
}

Introduction

Tenant

Environments

Customers

Accounts

KYC

Document reviews

Source of funds

Files

Webhooks

Sync

Sanctions

Query parameters

Returns

Account status values

Error codes

​Query parameters

​Returns

​Account status values

​Error codes

Query parameters

Returns

Account status values

Error codes