MEmeow
Entities

Get Entity Onboarding Status

Returns the onboarding status of a business entity, including uploaded documents and each representative's KYC status in the representatives array. The top-level kyc_status reflects the primary representative.

get/entities/{entity_id}

Request

Path parameters

entity_idstring required

The entity being onboarded.

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.