v1

latestOpenAPI 3.1.02026-07-228956435.8 KB

Onboardings

Get an onboarding

Retrieves the onboarding with the given id for the entity. Only onboardings belonging to the organization of the API key used are visible. Requesting an onboarding that does not exist or belongs to another organization or entity returns a 404 Not Found error.

get/entities/{entity_id}/onboardings/{id}

Path parameters

entity_idstring required

The unique identifier of the entity (for example ent_8anBwgZktbZH6ydyHa6Tm0eM).

idstring required

The unique identifier of the onboarding (for example onbprc_0ujsswThIGTUYm2K8FjOOfXtY1K).

Response

Returns the onboarding object with its current status, reviewed data, declared legal representatives and shareholders, and the status of every required document slot.

idstring required

Unique identifier of the onboarding.

object'onboarding' required

Type of the object. Always onboarding.

dataobject required

Reviewed data for the onboarding, grouped by type. Onboardings created through the API include company_information and transactional_profile. Fintoc sets declaration_accepted to true on creation and returns incorporation_date as an ISO 8601 datetime in UTC.

entity_idstring nullable required

Identifier of the entity this onboarding belongs to. null if not associated with an entity.

reviewed_atstring date-time nullable required

ISO 8601 datetime, in UTC, of when the onboarding was reviewed. null until it is reviewed.

source'api' | 'dashboard' required

Channel the onboarding is being completed through. One of api or dashboard.

Current status of the onboarding. One of pending, in_progress, submitted, approved, rejected or cancelled.

submittableboolean required

Whether the onboarding has every required field and document completed and can be submitted for review.

submitted_atstring date-time nullable required

ISO 8601 datetime, in UTC, of when the onboarding was submitted for review. null until it is submitted.

Example response

{
  "id": "onbprc_0ujsswThIGTUYm2K8FjOOfXtY1K",
  "data": {
    "company_information": {
      "incorporation_date": "2020-01-15T00:00:00.000Z",
      "business_activity": "Servicios financieros",
      "fiscal_address": "Av. Reforma 123, CDMX",
      "business_address": "Av. Insurgentes 456, CDMX",
      "settlement_account": "000000000000000000",
      "phone": "+521111111111"
    },
    "transactional_profile": {
      "resource_origins": [
        "trusts",
        "investments"
      ],
      "monthly_amount_range": "1_500000",
      "monthly_operations_range": "1_15000",
      "declaration_accepted": true
    }
  },
  "documents": [
    {
      "filename": "csf.pdf",
      "slot_key": "tax_registration_certificate",
      "status": "uploaded",
      "uploaded_at": "2026-01-15T14:30:00Z"
    }
  ],
  "entity_id": "ent_8anBwgZktbZH6ydyHa6Tm0eM",
  "legal_representatives": [
    {
      "id": "onblr_0ujsswThIGTUYm2K8FjOOfXtY1K",
      "documents": [
        {
          "filename": "csf.pdf",
          "slot_key": "tax_registration_certificate",
          "status": "uploaded",
          "uploaded_at": "2026-01-15T14:30:00Z"
        }
      ],
      "email": "rep@example.com",
      "first_name": "Test Customer 1",
      "identification_number": "AAAA010101HDFAAA01",
      "last_name": "Customer",
      "nationality": "mx",
      "position": "Director General"
    }
  ],
  "reviewed_at": "2026-01-16T09:00:00Z",
  "shareholders": [
    {
      "id": "onbsh_0ujsswThIGTUYm2K8FjOOfXtY1K",
      "document": {
        "filename": "csf.pdf",
        "slot_key": "tax_registration_certificate",
        "status": "uploaded",
        "uploaded_at": "2026-01-15T14:30:00Z"
      },
      "holder_id": "AAAA010101AAA",
      "last_name": "Customer",
      "name": "Test Customer 1",
      "parent_id": "onbsh_8anBwgZktbZH6ydyHa6Tm0eM",
      "percentage": 40,
      "type": "natural_person"
    }
  ],
  "source": "api",
  "status": "pending",
  "submitted_at": "2026-01-15T14:30:00Z"
}