Get available document types

Retrieve available document types and requirements per country for identity verification and compliance. The scope parameter controls which countries are included: core (default) returns documents for core countries only, supported returns documents for all countries with defined requirements, all returns documents for every country with dynamic fallback, and pre-onboarding returns documents from the CountryDocumentTypes table organized by entity type (PERSON/COMPANY). When countrySymbol is provided, returns documents for that specific country regardless of scope.

get/api/v1/documents

Request

Base URL: https://api-sandbox.koywe.com
URL: https://api-sandbox.koywe.com/api/v1/documents
Auth: none declared

Query parameters

entityType'PERSON' | 'COMPANY'

Filter documents by entity type. Only applicable when scope is onboarding. If not provided, returns documents for all entity types.

unknown

Filter documents by country symbol(s) (ISO 3166-1 alpha-2 code). Accepts single value or multiple values (e.g., countrySymbol=CL&countrySymbol=AR). For onboarding scope, returns documents for specified countries. For other scopes with single country, returns documents for that country.

scope'core' | 'supported' | 'all' | 'onboarding'

Filter documents by scope: core (default) for core countries (AR, CL, CO, PE, MX, BR, US, BO), supported for all countries with document definitions, all for every country with dynamic fallback, pre-onboarding for documents from CountryDocumentTypes table

Response

Get available documents per country based on scope. Returns GenericDocumentDto (country-keyed object) for core/supported/all scopes, or CountryDocumentTypesResponseDto for onboarding scope.

Example response

{
  "countrySymbol": "CL",
  "documentTypes": [
    {
      "id": "docdef_123",
      "label": "RUT",
      "labelEng": "Tax ID",
      "code": "RUT",
      "entityType": "PERSON"
    }
  ]
}

Changes

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