Onboarding object

An Onboarding holds the Know Your Customer review of an Entity: company information, legal representative, transactional profile, shareholders, and documents.

An Onboarding holds the Know Your Customer review of an Entity: company information, legal representative, transactional profile, shareholders, and documents. You create one onboarding per Entity, complete each step and document, and submit the onboarding for Fintoc to review.

The Onboarding object has these attributes:

FieldTypeDescription
idstringUnique identifier of the onboarding.
objectstringThe type of the object, which is always onboarding.
dataobjectReviewed data for each completed step, keyed by step key.
documentsarrayDocument slots across every step, with their upload status. See the OnboardingDocument object.
entity_idstringIdentifier of the Entity this onboarding belongs to. null if the onboarding is not associated with an Entity.
reviewed_atstringISO 8601 datetime in UTC when Fintoc reviewed the onboarding. null until Fintoc reviews the onboarding.
shareholdersarrayShareholders declared for the Entity. See the OnboardingShareholder object.
sourcestringCompletion channel for the onboarding. One of api or dashboard.
statusstringCurrent status of the onboarding. One of pending, in_progress, submitted, approved, rejected, or cancelled.
submittablebooleanWhether the onboarding has every required step and document completed.
submitted_atstringISO 8601 datetime in UTC when you submitted the onboarding for review. null until you submit the onboarding.

Onboarding Shareholder object

The OnboardingShareholder object has these attributes:

FieldTypeDescription
idstringUnique identifier of the shareholder.
objectstringThe type of the object, which is always onboarding_shareholder.
documentobjectIdentification document slot for the shareholder. See the OnboardingDocument object.
holder_idstringMexican tax ID (RFC) of the shareholder. null if not provided.
last_namestringLast name. Only present when type is natural_person.
namestringGiven name of a natural person, or business name of a legal entity.
parent_idstringIdentifier of the parent shareholder when nested. null for root shareholders.
percentagenumberParticipation percentage held by the shareholder, from 0 to 100.
typestringType of shareholder. One of natural_person or legal_entity.

Onboarding Document object

The OnboardingDocument object has these attributes:

FieldTypeDescription
filenamestringOriginal filename of the uploaded document. Only present when status is uploaded.
slot_keystringKey identifying the document slot.
statusstringDocument slot status. One of uploaded or missing.
uploaded_atstringISO 8601 datetime in UTC when you uploaded the document. Only present when status is uploaded.
{
  "id": "onbprc_0ujsswThIGTUYm2K8FjOOfXtY1K",
  "object": "onboarding",
  "data": {
    "company_information": {
      "legal_name": "Test Company 1"
    }
  },
  "documents": [
    {
      "filename": "csf.pdf",
      "slot_key": "tax_registration_certificate",
      "status": "uploaded",
      "uploaded_at": "2026-01-15T14:30:00Z"
    }
  ],
  "entity_id": "ent_8anBwgZktbZH6ydyHa6Tm0eM",
  "reviewed_at": null,
  "shareholders": [
    {
      "id": "onbsh_0ujsswThIGTUYm2K8FjOOfXtY1K",
      "object": "onboarding_shareholder",
      "document": {
        "filename": "ine.pdf",
        "slot_key": "identification",
        "status": "uploaded",
        "uploaded_at": "2026-01-15T14:30:00Z"
      },
      "holder_id": "AAAA010101AAA",
      "last_name": "Customer",
      "name": "Test Customer 1",
      "parent_id": null,
      "percentage": 76,
      "type": "natural_person"
    }
  ],
  "source": "api",
  "status": "in_progress",
  "submittable": false,
  "submitted_at": null
}