Customers

Get customer compliance requirements

Changed on

Verify that you have passed all required compliance information for a customer.

Returns a merged list of missing requirements plus any active overlays. Use this endpoint to check what information is still needed before submitting verification.

Note: When RFIs (Requests for Information) are issued, additional fields may be added to this response.

get/v1/customers/{id}/compliance

Request

Path parameters

idstring required
Example:cus_abc123

Customer ID

Query parameters

includeHostedProgressboolean

When true, merge open primary hosted-session drafts into the projection (MCP / hosted-aware reads). Default false.

forSessionIdstring

When set with includeHostedProgress, overlay applies only if the open draft is this session. Does not expose session ids in the response.

Headers

X-API-Keystring

API key

Response

Customer compliance status

customerIdstring required

Customer ID

updatedAtstring required

Last updated timestamp

validationErrorsstring[] required

Validation errors that would block submission (e.g. ownership requirements)

hasOpenHostedDraftboolean

True when an open primary hosted draft was considered for this projection. Session ids are not exposed (they are capability tokens). Customer record is unchanged until hosted submit.

hostedProgressAppliesToSessionboolean

When forSessionId is supplied: true if there is no open draft or the open draft is that session. When omitted: same as hasOpenHostedDraft for primary compliance reads.

hostedProgressUpdatedAtstring nullable

updatedAt of the hosted session whose progress was merged into this projection (null when none / not applied)

Example response

{
  "customerId": "cus_abc123",
  "updatedAt": "2026-01-15T10:30:00Z",
  "missingRequirements": [
    {
      "requirementType": "FIELD",
      "key": "businessData.legalName",
      "displayName": "Legal Name"
    },
    {
      "requirementType": "DOCUMENT",
      "key": "compliance.aml_policy",
      "displayName": "AML / BSA Policy"
    }
  ],
  "enhancedDiligence": {
    "missingRequirements": [
      {
        "requirementType": "FIELD",
        "key": "businessData.legalName",
        "displayName": "Legal Name",
        "entityId": "asp_abc123",
        "entityDisplayName": "Jane Owner"
      }
    ]
  },
  "validationErrors": [
    "At least one beneficial owner or control person must be identified."
  ],
  "hostedProgressUpdatedAt": "2026-10-07T18:30:00Z"
}

Changes

    • info

      added the new optional query request parameter forSessionId

    • info

      added the new optional query request parameter includeHostedProgress

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property /// to the response with the status