Descripción General
Los endpoints de requisitos por país ayudan a los desarrolladores a comprender qué campos son obligatorios para la creación de entidades en diferentes países. Cada país tiene reglas de validación específicas, formatos de identificación fiscal y campos requeridos.
Esto elimina el método de prueba y error al crear entidades y proporciona una guía clara sobre qué datos son necesarios.
Países Soportados
gu1 actualmente soporta 16 países con validación integral:
🇦🇷 Argentina Validación de CUIT
🇧🇷 Brasil Validación de CNPJ
🇲🇽 México Validación de RFC
🇨🇱 Chile Validación de RUT
🇨🇴 Colombia Validación de NIT
🇺🇾 Uruguay Validación de RUT
🇪🇨 Ecuador Validación de RUC
🇵🇾 Paraguay Validación de RUC
🇧🇴 Bolivia Validación de NIT
🇻🇪 Venezuela Validación de RIF
🇺🇸 Estados Unidos Validación de EIN
🇨🇦 Canadá Validación de BN
🇪🇸 España Validación de CIF
🇵🇹 Portugal Validación de NIPC
🇪🇪 Estonia Validación de Registrikood
Obtener Todos los Países
GET http://api.gu1.ai/entities/country-requirements
Recupere una lista de todos los países soportados.
Ejemplo de Respuesta
{
"success" : true ,
"countries" : [
{ "code" : "AR" , "name" : "Argentina" },
{ "code" : "BR" , "name" : "Brazil" },
{ "code" : "MX" , "name" : "Mexico" },
{ "code" : "US" , "name" : "United States" },
...
],
"total" : 16
}
Obtener Requisitos Específicos por País
GET http://api.gu1.ai/entities/country-requirements/:countryCode
Obtenga requisitos de validación detallados para un país específico.
Parámetros de Ruta
Código de país ISO 3166-1 alpha-2 (por ejemplo, “AR”, “BR”, “US”)
Campos de Respuesta
Indica si la solicitud fue exitosa
Detalles de validación del país Show propiedades de country
Nombre local para la identificación fiscal (por ejemplo, “CUIT”, “CNPJ”, “RFC”)
Patrón de expresión regular para la validación de identificación fiscal
Lista de nombres de campos de atributos requeridos
Lista de nombres de campos de atributos opcionales
Lista de registros oficiales para este país
Ejemplo de carga útil de solicitud Show propiedades de documentation
Ejemplo completo de cómo crear una entidad para este país
Ejemplos
Obtener Requisitos de Argentina
curl http://api.gu1.ai/entities/country-requirements/AR \
-H "Authorization: Bearer YOUR_API_KEY"
Ejemplo de Respuesta
{
"success" : true ,
"country" : {
"code" : "AR" ,
"name" : "Argentina" ,
"taxIdName" : "CUIT" ,
"taxIdFormat" : "^ \\ d{2}- \\ d{8}- \\ d{1}$" ,
"requiredFields" : [
"cuit" ,
"razonSocial" ,
"domicilioFiscal"
],
"optionalFields" : [
"iibb" ,
"actividadPrincipal" ,
"fechaInicioActividades"
],
"registries" : [
"AFIP" ,
"IGJ" ,
"RPC"
]
},
"documentation" : {
"example" : {
"type" : "company" ,
"externalId" : "company_123" ,
"name" : "Example Company" ,
"countryCode" : "AR" ,
"taxId" : "Example CUIT" ,
"attributes" : {
"cuit" : "Example cuit" ,
"razonSocial" : "Example razonSocial" ,
"domicilioFiscal" : "Example domicilioFiscal"
}
}
}
}
Ejemplos Específicos por País
🇦🇷 Argentina (CUIT)
{
"type" : "company" ,
"externalId" : "company_ar_001" ,
"name" : "Tech Solutions Argentina" ,
"countryCode" : "AR" ,
"taxId" : "30-71234567-8" ,
"attributes" : {
"cuit" : "30-71234567-8" ,
"razonSocial" : "Tech Solutions S.A." ,
"domicilioFiscal" : "Av. Corrientes 1234, CABA" ,
"iibb" : "901-123456-7" ,
"actividadPrincipal" : "Desarrollo de Software"
}
}
🇧🇷 Brasil (CNPJ)
{
"type" : "company" ,
"externalId" : "company_br_001" ,
"name" : "Tech Solutions Brasil" ,
"countryCode" : "BR" ,
"taxId" : "12.345.678/0001-90" ,
"attributes" : {
"cnpj" : "12.345.678/0001-90" ,
"razaoSocial" : "Tech Solutions Ltda" ,
"enderecoFiscal" : "Av. Paulista, 1000 - São Paulo, SP" ,
"inscricaoEstadual" : "123.456.789.012" ,
"cnae" : "6201-5/00"
}
}
🇲🇽 México (RFC)
{
"type" : "company" ,
"externalId" : "company_mx_001" ,
"name" : "Tech Solutions México" ,
"countryCode" : "MX" ,
"taxId" : "TSM980101ABC" ,
"attributes" : {
"rfc" : "TSM980101ABC" ,
"razonSocial" : "Tech Solutions S.A. de C.V." ,
"domicilioFiscal" : "Av. Reforma 123, Ciudad de México" ,
"regimenFiscal" : "601"
}
}
🇺🇸 Estados Unidos (EIN)
{
"type" : "company" ,
"externalId" : "company_us_001" ,
"name" : "Tech Solutions Inc" ,
"countryCode" : "US" ,
"taxId" : "12-3456789" ,
"attributes" : {
"ein" : "12-3456789" ,
"legalName" : "Tech Solutions Inc." ,
"address" : "123 Main St, San Francisco, CA 94102" ,
"stateOfIncorporation" : "Delaware" ,
"naicsCode" : "541511"
}
}
🇪🇸 España (CIF)
{
"type" : "company" ,
"externalId" : "company_es_001" ,
"name" : "Tech Solutions España" ,
"countryCode" : "ES" ,
"taxId" : "A12345678" ,
"attributes" : {
"cif" : "A12345678" ,
"razonSocial" : "Tech Solutions S.L." ,
"direccionFiscal" : "Calle Gran Vía 1, Madrid" ,
"cnae" : "6201"
}
}
Respuestas de Error
404 - País No Soportado
{
"success" : false ,
"error" : {
"code" : "COUNTRY_NOT_SUPPORTED" ,
"message" : "Country code 'XX' is not supported" ,
"details" : {
"countryCode" : "XX" ,
"supportedCountries" : [ "AR" , "BR" , "MX" , ... ]
}
}
}
Mejores Prácticas
Siempre consulte los requisitos del país antes de crear entidades para asegurarse de recopilar todos los datos necesarios de sus usuarios de antemano.
Almacenar en Caché los Requisitos
Los requisitos por país rara vez cambian. Considere almacenarlos en caché en su aplicación para reducir las llamadas a la API.
Validar del Lado del Cliente
Use el patrón regex de taxIdFormat para validar identificaciones fiscales en el lado del cliente antes de enviarlas a la API.
Localizar Nombres de Campos
Muestre los nombres de campos en el idioma del usuario. La API devuelve nombres de campos locales (por ejemplo, “razonSocial” para Argentina en lugar de “legalName”).
Próximos Pasos