/api/partner/v2/users/{id}/kyc

Headers

partner-api-key

string

required

Api key for the affiliated partner that is performing the request

Path Parameters

string

required

The id of the entity

Body

application/json

country

enum<string>

required

The country code for the user KYC

@description The country must be a valid ISO 3166-1 alpha-2 country code, see: @link https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2

Available options:

MX,

DO,

US,

AT,

BE,

BG,

HR,

CY,

CZ,

DK,

EE,

FI,

FR,

DE,

GR,

HU,

IE,

IT,

LV,

LT,

LU,

MT,

NL,

PL,

PT,

RO,

SK,

SI,

ES,

SE,

IS,

LI,

NO,

CH,

GB,

MC,

SM,

AD,

VA

Example:

"MX"

profession

enum<string>

required

The profession of the user.

Available options:

EMPLOYEE,

ENTREPRENEUR,

MANAGER,

NURSE,

STUDENT,

PHYSICIST,

EXECUTIVE,

HOUSEWORK,

ENGINEER,

RETIRED,

MEASURED,

NOT_SPECIFIED,

OPERATOR,

PENSIONER,

POLITICIAN,

PRODUCTION,

PROFESSIONAL,

TEACHER,

OWNER,

PSYCHOLOGIST,

PUBLIC_RELATIONS,

LEGAL_REPRESENTATIVE,

MR,

MRS,

SUPERVISOR,

TECHNICIAN,

TRANSPORTER,

SALES

Example:

"EMPLOYEE, ENTREPRENEUR, MANAGER, NURSE, STUDENT."

countryOfBirth

enum<string>

required

The country of birth of the user.

Available options:

Aruba,

Afghanistan,

Angola,

Anguilla,

Åland Islands,

Albania,

Andorra,

United Arab Emirates,

Argentina,

Armenia,

American Samoa,

Antarctica,

French Southern Territories,

Antigua and Barbuda,

Australia,

Austria,

Azerbaijan,

Burundi,

Belgium,

Benin,

Bonaire, Sint Eustatius and Saba,

Burkina Faso,

Bangladesh,

Bulgaria,

Bahrain,

Bahamas,

Bosnia and Herzegovina,

Saint Barthélemy,

Belarus,

Belize,

Bermuda,

Bolivia,

Brazil,

Barbados,

Brunei Darussalam,

Bhutan,

Bouvet Island,

Botswana,

Central African Republic,

Canada,

Cocos (Keeling) Islands,

Switzerland,

Chile,

China,

Côte d'Ivoire,

Cameroon,

Congo, The Democratic Republic of the,

Congo,

Cook Islands,

Colombia,

Comoros,

Cabo Verde,

Costa Rica,

Cuba,

Curaçao,

Christmas Island,

Cayman Islands,

Cyprus,

Czechia,

Germany,

Djibouti,

Dominica,

Denmark,

Dominican Republic,

Algeria,

Ecuador,

Egypt,

Eritrea,

Western Sahara,

Spain,

Estonia,

Ethiopia,

Finland,

Fiji,

Falkland Islands (Malvinas),

France,

Faroe Islands,

Micronesia, Federated States of,

Gabon,

United Kingdom,

Georgia,

Guernsey,

Ghana,

Gibraltar,

Guinea,

Guadeloupe,

Gambia,

Guinea-Bissau,

Equatorial Guinea,

Greece,

Grenada,

Greenland,

Guatemala,

French Guiana,

Guam,

Guyana,

Hong Kong,

Heard Island and McDonald Islands,

Honduras,

Croatia,

Haiti,

Hungary,

Indonesia,

Isle of Man,

India,

British Indian Ocean Territory,

Ireland,

Iran, Islamic Republic of,

Iraq,

Iceland,

Israel,

Italy,

Jamaica,

Jersey,

Jordan,

Japan,

Kazakhstan,

Kenya,

Kyrgyzstan,

Cambodia,

Kiribati,

Saint Kitts and Nevis,

Korea, Republic of,

Kuwait,

Lao People's Democratic Republic,

Lebanon,

Liberia,

Libya,

Saint Lucia,

Liechtenstein,

Sri Lanka,

Lesotho,

Lithuania,

Luxembourg,

Latvia,

Macao,

Saint Martin (French part),

Morocco,

Monaco,

Moldova, Republic of,

Madagascar,

Maldives,

Mexico,

Marshall Islands,

Macedonia,

Mali,

Malta,

Myanmar,

Montenegro,

Mongolia,

Northern Mariana Islands,

Mozambique,

Mauritania,

Montserrat,

Martinique,

Mauritius,

Malawi,

Malaysia,

Mayotte,

Namibia,

New Caledonia,

Niger,

Norfolk Island,

Nigeria,

Nicaragua,

Niue,

Netherlands,

Norway,

Nepal,

Nauru,

New Zealand,

Oman,

Pakistan,

Panama,

Pitcairn,

Peru,

Philippines,

Palau,

Papua New Guinea,

Poland,

Puerto Rico,

Korea, Democratic People's Republic of,

Portugal,

Paraguay,

Palestine, State of,

French Polynesia,

Qatar,

Réunion,

Romania,

Russian Federation,

Rwanda,

Saudi Arabia,

Sudan,

Senegal,

Singapore,

South Georgia and the South Sandwich Islands,

Saint Helena, Ascension and Tristan da Cunha,

Svalbard and Jan Mayen,

Solomon Islands,

Sierra Leone,

El Salvador,

San Marino,

Somalia,

Saint Pierre and Miquelon,

Serbia,

South Sudan,

Sao Tome and Principe,

Suriname,

Slovakia,

Slovenia,

Sweden,

Eswatini,

Sint Maarten (Dutch part),

Seychelles,

Syrian Arab Republic,

Turks and Caicos Islands,

Chad,

Togo,

Thailand,

Tajikistan,

Tokelau,

Turkmenistan,

Timor-Leste,

Tonga,

Trinidad and Tobago,

Tunisia,

Turkey,

Tuvalu,

Taiwan, Province of China,

Tanzania, United Republic of,

Uganda,

Ukraine,

United States Minor Outlying Islands,

Uruguay,

United States,

Uzbekistan,

Holy See (Vatican City State),

Saint Vincent and the Grenadines,

Venezuela, Bolivarian Republic of,

Virgin Islands, British,

Virgin Islands, U.S.,

Viet Nam,

Vanuatu,

Wallis and Futuna,

Samoa,

Yemen,

South Africa,

Zambia,

Zimbabwe

Example:

"MX"

selfieUrl

string

required

The selfie url of the user.

Example:

"https://example.com/selfie.jpg"

documents

object[]

The documents of the user.

Show child attributes

Example:

"[{ type: \"NATIONAL_ID\", fileUrl: \"https://example.com/document.jpg\" }]"

address

object

The address of the user.

Show child attributes

pep

object

The PEP of the user.

Show child attributes

beneficiaryOwner

object

In case that the beneficiary owner is the same as the user, this field is not required.

Show child attributes

resourceProvider

object

In case that the resource provider is the same as the user, this field is not required.

Show child attributes

realOwner

object

In case that the real owner is the same as the user, this field is not required.

Show child attributes

phoneNumber

string

The phone number of the user.

Example:

"+524401234567"

taxId

string

The tax id of the user.

Example:

"LOZG7802117B9"

economicActivity

enum<string>

The economic activity of the user.

Available options:

ACTIVIDADES DE CLUBES DEPORTIVOS PROFESIONALES,

ADMINISTRACION DE INMUEBLES,

ADQUISICION DE BIENES MUEBLES,

AGENCIA ADUANAL,

AGENCIA DE MUDANZAS,

AGENCIA DE PUBLICIDAD,

AGENCIA DE VIAJES,

AGENCIA DE COLOCACION,

ALMACENAMIENTO,

ALQUILER DE AUTOMOVILES,

ALQUILER DE BIENES MUEBLES,

ALQUILER DE EQUIPO DE TRANSPORTE,

ALQUILER DE INMUEBLES,

ALQUILER DE MAQUINARIA Y EQUIPO,

ARRENDAMIENTO DE BIENES INMUEBLES,

ARRENDAMIENTO DE EQUIPO,

ASOCIACION,

ATENCION MEDICA Y DE SALUD,

AUTOTRANSPORTE DE CARGA,

AUTOTRANSPORTE DE PASAJEROS,

BOLSA DE VALORES,

CAFETERIA,

CAJA DE AHORRO,

CAPTACION DE FONDOS,

CASA DE BOLSA,

CASA DE CAMBIO,

CENTRO CAMBIARIO,

CENTRO DE APUESTAS,

CENTRO DE ESPECTACULOS,

CENTRO DEPORTIVO,

CINE,

CLINICA,

CLUB DEPORTIVO,

COBRANZA,

COMERCIO AL POR MAYOR,

COMERCIO AL POR MENOR,

COMERCIO DE ALIMENTOS,

COMERCIO DE AUTOMOVILES,

COMERCIO DE BEBIDAS,

COMERCIO DE BIENES MUEBLES,

COMERCIO DE COMBUSTIBLES,

COMERCIO DE COMPUTADORAS,

COMERCIO DE ELECTRODOMESTICOS,

COMERCIO DE EQUIPO,

COMERCIO DE FARMACOS,

COMERCIO DE FRUTAS Y VERDURAS,

COMERCIO DE JOYERIA,

COMERCIO DE LICORES,

COMERCIO DE MAQUINARIA,

COMERCIO DE MATERIALES,

COMERCIO DE METALERIA,

COMERCIO DE PAPELERIA,

COMERCIO DE PRODUCTOS QUIMICOS,

COMERCIO DE ROPA,

COMERCIO DE TELAS,

COMERCIO DE VEHICULOS,

COMERCIO ELECTRONICO,

COMPAÑIA ASEGURADORA,

COMUNICACION,

CONSTRUCCION,

CONSULTORIA,

COOPERATIVA,

CORREDURIA,

CRIANZA DE ANIMALES,

DESARROLLO DE SOFTWARE,

DISEÑO GRAFICO,

DISTRIBUCION,

EDUCACION,

EDITORIAL,

ELABORACION DE BEBIDAS,

ELABORACION DE PRODUCTOS,

EMPRESA DE TRANSPORTE,

ENSAMBLAJE,

ENSENANZA,

ENTRETENIMIENTO,

EXPORTACION,

FABRICACION,

FABRICACION DE EQUIPO,

FABRICACION DE JUGUETES,

FIDEICOMISO,

FINANCIERA,

FONDO DE INVERSION,

FOTOGRAFIA,

FUNDACION,

GESTORIA,

GIMNASIO,

HOSPEDAJE,

IMPRENTA,

IMPORTACION,

INDUSTRIA ALIMENTARIA,

INDUSTRIA AUTOMOTRIZ,

INDUSTRIA DE BEBIDAS,

INDUSTRIA DE LA CONSTRUCCION,

INDUSTRIA DE LA MADERA,

INDUSTRIA ELECTRICA,

INDUSTRIA MANUFACTURERA,

INDUSTRIA METALURGICA,

INDUSTRIA QUIMICA,

INGENIERIA,

INMOBILIARIA,

INSTITUCION BANCARIA,

INSTITUCION DE SEGUROS,

INTERNET,

INVESTIGACION,

JOYERIA,

LABORATORIO,

LIMPIEZA,

LOGISTICA,

MANUFACTURA,

MARKETING,

MECANICA,

MEDIOS DE COMUNICACION,

MERCADOTECNIA,

MINERIA,

MONTAJE DE EVENTOS,

MULTINACIONAL,

MUSEO,

MUSICA,

NEGOCIO,

NOTARIA,

OFICINA,

OPERADORA,

OPERADORA DE SERVICIOS,

ORGANIZACION,

ORGANIZACION NO GUBERNAMENTAL,

PANADERIA,

PARQUE INDUSTRIAL,

PENSION,

PERIODICO,

PINTURA,

PRESTAMO,

PRODUCTORA,

PROMOTORA,

PROVEEDURIA,

PUBLICIDAD,

PUESTO DE COMIDA,

RECAUDACION DE FONDOS,

RECURSOS HUMANOS,

REPARACION,

RESTAURANTE,

SEGUROS,

SERVICIO A DOMICILIO,

SERVICIO AL CLIENTE,

SERVICIO DE LIMPIEZA,

SERVICIO DE SALUD,

SERVICIO TECNICO,

SERVICIOS ADMINISTRATIVOS,

SERVICIOS CONTABLES,

SERVICIOS DE CONSULTORIA,

SERVICIOS DE MANTENIMIENTO,

SERVICIOS DE SEGURIDAD,

SERVICIOS ESCOLARES,

SUPERMERCADO,

SUPERVISION DE OBRA,

SUPERVISION INDUSTRIAL,

TALLER,

TAXI,

TELECOMUNICACIONES,

TIENDA DEPARTAMENTAL,

TRANSPORTE,

TURISMO,

UNIVERSIDAD,

VENTA DE ALIMENTOS,

VENTA DE BEBIDAS,

VENTA DE ELECTRODOMESTICOS,

VENTA DE PRODUCTOS,

VENTA DE SERVICIOS

Example:

1234567890

Capa Partner API - V1

Headers

Path Parameters

Body