Entities

Submit Due Diligence Form

Submit an enhanced due diligence form for a business entity. Some industries require additional due diligence before the application can be submitted (check next_step.missing on the onboarding status). Every standalone form with a schema can be submitted here. Supporting documents a form refers to are uploaded separately as entity documents, not in this body. Your answers are checked against the form schema, so fetch it first and send everything it marks required. Returns the updated onboarding status.

post/entities/{entity_id}/due-diligence

Request

Path parameters

entity_idstring required

The entity being onboarded.

Request body

OR
OR
OR
OR
OR
OR
OR
OR
OR

Response

Successful Response

entity_idstring uuid required

Public ID of the onboarded business entity, stable across the onboarding lifecycle and matching the entity_id used in the Customer API, MCP, and webhook payloads.

status'pending_document_upload' | 'pending_user_action' | 'submitted' | 'under_review' | 'approved' | 'rejected' required
business_namestring nullable required

Legal business name.

created_atstring date-time required

ISO 8601 date-time in the format YYYY-MM-DDThh:mm:ss.nnn[Z|[+|-]hh:mm] (per IETF RFC 3339).

updated_atstring date-time required

ISO 8601 date-time in the format YYYY-MM-DDThh:mm:ss.nnn[Z|[+|-]hh:mm] (per IETF RFC 3339).

kyc_status'not_started' | 'pending' | 'action_required' | 'approved' | 'rejected' required
onboarding_type'api' | 'smb' | 'mcp' | 'partner' required
consent_urlstring nullable required

Link where the primary representative reviews and accepts the required agreements and disclosures in their browser. Populated once the application has been submitted; share it with the primary representative. The link needs no login and anyone holding it can accept on the business's behalf, so treat it as a secret.

Changes

No recorded changes to this operation across all 1 revision of this API.