Get KYC form answers

GET

kyc

:userid

question-answers

curl https://api.zquence.ai/v1/kyc/usr_01HX3ZAB.../question-answers \
  -H "x-api-key: $ZQUENCE_PUBLIC_KEY" \
  -H "x-api-secret: $ZQUENCE_SECRET_KEY" \
  -H "x-request-id: req_01J6V..."

{
  "data": {
    "id": "kyc_01HX3ZH...",
    "type": "kyc_submission",
    "subject": {
      "userId": "usr_01HX3ZAB...",
      "tenantId": "tnt_01HX3Z8MQW...",
      "environmentId": "env_01J6V...",
      "accountType": {
        "id": "real_estate"
      }
    },
    "form": {
      "id": "form_current",
      "version": 3,
      "schemaVersion": "1.0",
      "snapshotId": null
    },
    "submission": {
      "status": "submitted",
      "submittedAt": "2026-08-28T10:00:00.000Z",
      "updatedAt": "2026-08-28T10:03:00.000Z"
    },
    "verification": {
      "status": "submitted",
      "provider": {
        "code": "onfido",
        "status": "approved"
      }
    },
    "sections": [
      {
        "id": "identity",
        "title": "Identity",
        "description": "Identity details",
        "order": 1,
        "fields": [
          {
            "id": "full_name",
            "key": "full_name",
            "label": "Full name",
            "type": "text",
            "required": true,
            "order": 1,
            "answer": {
              "value": "Ada Lovelace",
              "displayValue": "Ada Lovelace"
            },
            "attributes": {
              "includeInDownloadableForm": true
            },
            "note": null
          },
          {
            "id": "passport_upload",
            "key": "passport_upload",
            "label": "Passport",
            "type": "file",
            "answer": {
              "value": {
                "documentId": "kyc_doc_...",
                "fileName": "passport.pdf",
                "mimeType": "application/pdf"
              },
              "displayValue": "passport.pdf"
            }
          }
        ]
      }
    ]
  },
  "meta": {
    "requestId": "req_01J6V...",
    "apiVersion": "2026-08-01",
    "generatedAt": "2026-08-28T10:04:00.000Z"
  }
}

Requires kyc.read. This endpoint returns the backend-authoritative KYC form submission in a canonical { data, meta } JSON shape. Use it when an integration needs the customer’s submitted KYC form details without downloading a PDF export. File uploads and signatures are returned as opaque document/signature references with display names. The response does not expose storage keys.

Path parameters

string

required

The user ID whose submitted KYC form answers should be retrieved.

Returns

string | null

KYC submission record ID.

string

Always kyc_submission.

object

User, tenant, environment, and account-type identifiers for the submission.

object

Runtime form identity, version, and schema version pinned to the submission.

object

KYC submission status and timestamps.

object

KYC verification status and provider status metadata.

array

Submitted form sections. Each section contains ordered fields; grouped questions contain nested fields instead of flattening child answers into the top-level list.

object

Request metadata including requestId, apiVersion, and generatedAt.

Error codes

Status	Meaning
`401`	Missing or invalid API key pair.
`403`	API key does not include `kyc.read`, or the caller cannot access the user.
`404`	KYC record not found for this user in the caller’s tenant/environment.

curl https://api.zquence.ai/v1/kyc/usr_01HX3ZAB.../question-answers \
  -H "x-api-key: $ZQUENCE_PUBLIC_KEY" \
  -H "x-api-secret: $ZQUENCE_SECRET_KEY" \
  -H "x-request-id: req_01J6V..."

{
  "data": {
    "id": "kyc_01HX3ZH...",
    "type": "kyc_submission",
    "subject": {
      "userId": "usr_01HX3ZAB...",
      "tenantId": "tnt_01HX3Z8MQW...",
      "environmentId": "env_01J6V...",
      "accountType": {
        "id": "real_estate"
      }
    },
    "form": {
      "id": "form_current",
      "version": 3,
      "schemaVersion": "1.0",
      "snapshotId": null
    },
    "submission": {
      "status": "submitted",
      "submittedAt": "2026-08-28T10:00:00.000Z",
      "updatedAt": "2026-08-28T10:03:00.000Z"
    },
    "verification": {
      "status": "submitted",
      "provider": {
        "code": "onfido",
        "status": "approved"
      }
    },
    "sections": [
      {
        "id": "identity",
        "title": "Identity",
        "description": "Identity details",
        "order": 1,
        "fields": [
          {
            "id": "full_name",
            "key": "full_name",
            "label": "Full name",
            "type": "text",
            "required": true,
            "order": 1,
            "answer": {
              "value": "Ada Lovelace",
              "displayValue": "Ada Lovelace"
            },
            "attributes": {
              "includeInDownloadableForm": true
            },
            "note": null
          },
          {
            "id": "passport_upload",
            "key": "passport_upload",
            "label": "Passport",
            "type": "file",
            "answer": {
              "value": {
                "documentId": "kyc_doc_...",
                "fileName": "passport.pdf",
                "mimeType": "application/pdf"
              },
              "displayValue": "passport.pdf"
            }
          }
        ]
      }
    ]
  },
  "meta": {
    "requestId": "req_01J6V...",
    "apiVersion": "2026-08-01",
    "generatedAt": "2026-08-28T10:04:00.000Z"
  }
}

KYC form answers can contain regulated PII. Store and transmit this JSON according to your tenant retention policy and regional data-residency obligations.

curl https://api.zquence.ai/v1/kyc/usr_01HX3ZAB.../question-answers \
  -H "x-api-key: $ZQUENCE_PUBLIC_KEY" \
  -H "x-api-secret: $ZQUENCE_SECRET_KEY" \
  -H "x-request-id: req_01J6V..."

{
  "data": {
    "id": "kyc_01HX3ZH...",
    "type": "kyc_submission",
    "subject": {
      "userId": "usr_01HX3ZAB...",
      "tenantId": "tnt_01HX3Z8MQW...",
      "environmentId": "env_01J6V...",
      "accountType": {
        "id": "real_estate"
      }
    },
    "form": {
      "id": "form_current",
      "version": 3,
      "schemaVersion": "1.0",
      "snapshotId": null
    },
    "submission": {
      "status": "submitted",
      "submittedAt": "2026-08-28T10:00:00.000Z",
      "updatedAt": "2026-08-28T10:03:00.000Z"
    },
    "verification": {
      "status": "submitted",
      "provider": {
        "code": "onfido",
        "status": "approved"
      }
    },
    "sections": [
      {
        "id": "identity",
        "title": "Identity",
        "description": "Identity details",
        "order": 1,
        "fields": [
          {
            "id": "full_name",
            "key": "full_name",
            "label": "Full name",
            "type": "text",
            "required": true,
            "order": 1,
            "answer": {
              "value": "Ada Lovelace",
              "displayValue": "Ada Lovelace"
            },
            "attributes": {
              "includeInDownloadableForm": true
            },
            "note": null
          },
          {
            "id": "passport_upload",
            "key": "passport_upload",
            "label": "Passport",
            "type": "file",
            "answer": {
              "value": {
                "documentId": "kyc_doc_...",
                "fileName": "passport.pdf",
                "mimeType": "application/pdf"
              },
              "displayValue": "passport.pdf"
            }
          }
        ]
      }
    ]
  },
  "meta": {
    "requestId": "req_01J6V...",
    "apiVersion": "2026-08-01",
    "generatedAt": "2026-08-28T10:04:00.000Z"
  }
}

Introduction

Tenant

Environments

Customers

Accounts

KYC

Document reviews

Source of funds

Files

Webhooks

Sync

Sanctions

Get KYC form answers

Path parameters

Returns

Error codes

​Path parameters

​Returns

​Error codes

Path parameters

Returns

Error codes