swagger: '2.0'
info:
title: 'Vant/Age - Simulación'
description: "Simulador del segmentador de cartera vencida Vant/Age que clasifica las cuentas en 6 calificaciones (de la A a la F) de acuerdo a la posibilidad del incremento en el tramo de mora de cada uno de tus clientes los siguientes 30 días, acorde a su comportamiento histórico contigo y con otros otorgantes de crédito.
"
version: 2.0.0
termsOfService: 'https://developer.circulodecredito.com.mx/legal'
contact:
email: 'api@circulodecredito.com.mx'
license:
name: 'Derechos reservados Circulo de Crédito 2020'
url: 'http://www.circulodecredito.com.mx'
host: 'services.circulodecredito.com.mx'
basePath: '/sandbox/v2/vantage'
tags:
- name: 'Vant/Age'
description: 'Por Aportantes y No Aportantes'
externalDocs:
description: 'Portal de desarrolladores'
url: 'https://developer.circulodecredito.com.mx/productos/vantage'
schemes:
- 'https'
paths:
'/aportantes':
post:
summary: 'Generación de Vant/Age por datos de usuarios Aportantes'
description: 'Aportante: Es un Otorgante de Crédito que reporta su base de datos a Círculo de Crédito.
Vant/Age genera como resultado una letra de la A a la F que indica la probabilidad de migración de la cuenta al siguiente bucket de mora; dicha probabilidad se relaciona directamente con los días de atraso de la cuenta y el tipo de contrato que tiene.
La tabla de distribución por segmento de negocio se encuentran a continuación, y muestra los porcentajes de probabilidad de migración de cartera analizada de acuerdo a la calificación de Vant/Age. | Días de Atraso |
| 1 a 30 | 31 a 60 | 61 a 90 | 91 a 180 | 181 a 365 |
| Producto | Calificación | % RR |
| Pagos Fijos (Mensual) | A | 18.60% | 21.20% | 52.00% | 52.40% | 55.20% |
| B | 23.50% | 40.90% | 65.40% | 63.90% | 70.10% |
| C | 30.40% | 60.20% | 76.20% | 74.80% | 79.40% |
| D | 38.10% | 66.80% | 83.70% | 85.80% | 84.60% |
| E | 41.20% | 76.60% | 90.70% | 92.70% | 94.60% |
| F | 64.50% | 83.50% | 93.00% | 97.10% | 98.50% |
| | Días de Atraso |
| 1 a 30 | 31 a 60 | 61 a 90 | 91 a 180 | 181 a 365 |
| Producto | Calificación | % RR |
| Pagos Fijos (Semanal) | A | 3.7% | 19.50% | 29.10% | 32.30% | 68.10% |
| B | 7.50% | 26.50% | 41.20% | 50.40% | 83.60% |
| C | 12.30% | 37.40% | 56.80% | 74.10% | 91.50% |
| D | 17.60% | 46.70% | 67.60% | 84.70% | 92.70% |
| E | 22.40% | 54.70% | 77.00% | 91.60% | 95.10% |
| F | 30.60% | 68.40% | 83.90% | 96.70% | 97.80% |
| | Días de Atraso |
| 1 a 30 | 31 a 60 | 61 a 90 | 91 a 180 | 181 a 365 |
| Producto | Calificación | % RR |
| Revolvente | A | 7.20% | 27.00% | 37.40% | 80.90% | 85.90% |
| B | 12.50% | 39.70% | 53.20% | 84.00% | 93.50% |
| C | 20.20% | 49.80% | 64.00% | 88.70% | 96.00% |
| D | 29.70% | 57.30% | 75.80% | 90.10% | 97.00% |
| E | 40.40% | 65.30% | 85.90% | 92.80% | 97.90% |
| F | 53.70% | 81.50% | 91.00% | 95.40% | 99.00% |
'
tags:
- 'Vant/Age'
operationId: 'getVantageAportantes'
consumes:
- 'application/json'
produces:
- 'application/json'
parameters:
- name: 'x-api-key'
in: 'header'
required: true
type: 'string'
description: 'ConsumerKey obtenido desde el portal de desarrolladores'
- in: 'body'
name: 'body'
description: 'Ejemplos para generar diferentes respuestas:
- Status Code 200. Calificación A
{
- "folio": "1500001",
"numeroCuenta": "2000001",
"diasAtraso": 21,
"tipoContrato": "CA"
}
- Status Code 200. Codigo de exclusión E3
{
- "folio": "1500094",
"numeroCuenta": "2000094",
"diasAtraso": 37,
"tipoContrato": "PP"
}
Nota: Para más casos con Status Code 200, consulte la colección de Postman
- Status Code 400
{
- "folio": "1500095",
"diasAtraso": 37,
"tipoContrato": "PPP"
}
- Status Code 401
{
- "folio": "1500096",
"numeroCuenta": "2000096",
"diasAtraso": 37,
"tipoContrato": "PP"
}
- Status Code 403
{
- "folio": "1500100",
"numeroCuenta": "2000100",
"diasAtraso": 37,
"tipoContrato": "PP"
}
- Status Code 404
{
- "folio": "1500101",
"numeroCuenta": "2000101",
"diasAtraso": 37,
"tipoContrato": "PP"
}
- Status Code 429
{
- "folio": "1500102",
"numeroCuenta": "2000102",
"diasAtraso": 37,
"tipoContrato": "PP"
}
- Status Code 500
{
- "folio": "1500103",
"numeroCuenta": "2000103",
"diasAtraso": 37,
"tipoContrato": "PP"
}
- Status Code 503
{
- "folio": "1500104",
"numeroCuenta": "2000104",
"diasAtraso": 37,
"tipoContrato": "PP"
}
'
required: true
schema:
$ref: '#/definitions/AportantesPeticion'
responses:
'200':
description: 'OK'
schema:
$ref: '#/definitions/Respuesta'
'400':
description: "BAD REQUEST"
schema:
$ref: "#/definitions/Errores"
examples:
application/json:
errores:
- codigo: "400.1"
mensaje: "El campo \"{Campo}\" no puede estar vacío."
'404':
description: "NOT FOUND"
schema:
$ref: "#/definitions/Errores"
examples:
application/json:
errores:
- codigo: "404.1"
mensaje: "No se encontraron resultados."
'401':
description: "UNAUTHORIZED"
schema:
$ref: "#/definitions/Errores"
examples:
application/json:
errores:
- codigo: "401.1"
mensaje: 'Acceso no autorizado, x-api-key no válida.'
- codigo: '401.2'
mensaje: 'Acceso no autorizado.'
- codigo: '401.3'
mensaje: 'Acceso no autorizado, no tiene el producto asociado.'
- codigo: '401.4'
mensaje: 'Acceso no autorizado, no tiene acceso al recurso.'
'403':
description: "FORBIDDEN"
schema:
$ref: "#/definitions/Errores"
examples:
application/json:
errores:
- codigo: "403.1"
mensaje: "No se pudo autenticar, x-signature no es válida"
'429':
description: 'TOO MANY REQUESTS'
schema:
$ref: '#/definitions/Errores'
examples:
application/json:
errores:
- codigo: '429.1'
mensaje: 'Se han enviado demasiadas solicitudes. Se debe esperar antes de realizar una nueva solicitud.'
'500':
description: "INTERNAL SERVER ERROR"
examples:
application/json:
errores:
- codigo: "500.1"
mensaje: "Ocurrió un problema, inténtelo nuevamente más tarde."
schema:
$ref: "#/definitions/Errores"
'503':
description: 'SERVICE UNAVAILABLE'
examples:
application/json:
errores:
- codigo: "503.1"
mensaje: "Servicio no disponible."
schema:
$ref: "#/definitions/Errores"
'/noAportantes':
post:
summary: 'Generación de Vant/Age por datos de usuarios NO Aportantes'
description: 'No Aportante: Es un Otorgante de Crédito que reporta su base de datos a una Sociedad de Información Crediticia distinta a Círculo de Crédito.
Vant/Age genera como resultado una letra de la A a la F que indica la probabilidad de migración de la cuenta al siguiente bucket de mora; dicha probabilidad se relaciona directamente con los días de atraso de la cuenta y el tipo de contrato que tiene.
La tabla de distribución por segmento de negocio se encuentran a continuación, y muestra los porcentajes de probabilidad de migración de cartera analizada de acuerdo a la calificación de Vant/Age. | Días de Atraso |
| 1 a 30 | 31 a 60 | 61 a 90 | 91 a 180 | 181 a 365 |
| Producto | Calificación | % RR |
| Pagos Fijos (Mensual) | A | 18.60% | 21.20% | 52.00% | 52.40% | 55.20% |
| B | 23.50% | 40.90% | 65.40% | 63.90% | 70.10% |
| C | 30.40% | 60.20% | 76.20% | 74.80% | 79.40% |
| D | 38.10% | 66.80% | 83.70% | 85.80% | 84.60% |
| E | 41.20% | 76.60% | 90.70% | 92.70% | 94.60% |
| F | 64.50% | 83.50% | 93.00% | 97.10% | 98.50% |
| | Días de Atraso |
| 1 a 30 | 31 a 60 | 61 a 90 | 91 a 180 | 181 a 365 |
| Producto | Calificación | % RR |
| Pagos Fijos (Semanal) | A | 3.7% | 19.50% | 29.10% | 32.30% | 68.10% |
| B | 7.50% | 26.50% | 41.20% | 50.40% | 83.60% |
| C | 12.30% | 37.40% | 56.80% | 74.10% | 91.50% |
| D | 17.60% | 46.70% | 67.60% | 84.70% | 92.70% |
| E | 22.40% | 54.70% | 77.00% | 91.60% | 95.10% |
| F | 30.60% | 68.40% | 83.90% | 96.70% | 97.80% |
| | Días de Atraso |
| 1 a 30 | 31 a 60 | 61 a 90 | 91 a 180 | 181 a 365 |
| Producto | Calificación | % RR |
| Revolvente | A | 7.20% | 27.00% | 37.40% | 80.90% | 85.90% |
| B | 12.50% | 39.70% | 53.20% | 84.00% | 93.50% |
| C | 20.20% | 49.80% | 64.00% | 88.70% | 96.00% |
| D | 29.70% | 57.30% | 75.80% | 90.10% | 97.00% |
| E | 40.40% | 65.30% | 85.90% | 92.80% | 97.90% |
| F | 53.70% | 81.50% | 91.00% | 95.40% | 99.00% |
'
tags:
- 'Vant/Age'
operationId: 'getVantageNoAportantes'
consumes:
- 'application/json'
produces:
- 'application/json'
parameters:
- name: 'x-api-key'
in: 'header'
required: true
type: 'string'
description: 'ConsumerKey obtenido desde el portal de desarrolladores'
- in: 'body'
name: 'body'
description: 'Ejemplos para generar diferentes respuestas:
- Status Code 200. Calificación A
{"folio": "1600001",
"tipoProducto": "R",
"tipoContrato": "TC",
"frecuenciaPago": "M",
"diasAtraso": 21,
"numeroCuenta": "3000001",
"fechaApertura": "2019-01-01",
"saldoActual": 15301,
"persona": {
"apellidoPaterno": "PRUEBAP01",
"apellidoMaterno": "PRUEBAM01",
"primerNombre": "JUAN01",
"fechaNacimiento": "1980-01-01",
"domicilio": {
"direccion": "PASADISO ENCONTRADO 1",
"coloniaPoblacion": "MONTEVIDEO",
"delegacionMunicipio": "GUSTAVO A MADERO",
"ciudad": "CIUDAD DE MÉXICO",
"estado": "CDMX",
"CP": "7730"
}
}
} - Status Code 200. Codigo de exclusión E3
{"folio": "1600094",
"tipoProducto": "R",
"tipoContrato": "TC",
"frecuenciaPago": "M",
"diasAtraso": 27,
"numeroCuenta": "3000094",
"fechaApertura": "2019-04-04",
"saldoActual": 15394,
"persona": {
"apellidoPaterno": "PRUEBAP94",
"apellidoMaterno": "PRUEBAM94",
"primerNombre": "JUAN94",
"fechaNacimiento": "1980-04-03",
"domicilio": {
"direccion": "PASADISO ENCONTRADO 94",
"coloniaPoblacion": "MONTEVIDEO",
"delegacionMunicipio": "GUSTAVO A MADERO",
"ciudad": "CIUDAD DE MÉXICO",
"estado": "CDMX",
"CP": "7730"
}
}
} Nota: Para más casos con Status Code 200, consulte la colección de Postman
- Status Code 400
{"folio": "1600095",
"tipoProducto": "R",
"tipoContrato": "TCC",
"frecuenciaPago": "M",
"diasAtraso": 27,
"fechaApertura": "2019-04-05",
"saldoActual": 15395,
"persona": {
"apellidoPaterno": "PRUEBAP95",
"apellidoMaterno": "PRUEBAM95",
"primerNombre": "JUAN95",
"fechaNacimiento": "1980-04-04",
"domicilio": {
"direccion": "PASADISO ENCONTRADO 95",
"coloniaPoblacion": "MONTEVIDEO",
"delegacionMunicipio": "GUSTAVO A MADERO",
"ciudad": "CIUDAD DE MÉXICO",
"estado": "CDMX",
"CP": "7730"
}
}
} - Status Code 401
{"folio": "1600096",
"tipoProducto": "R",
"tipoContrato": "TC",
"frecuenciaPago": "M",
"diasAtraso": 27,
"numeroCuenta": "3000096",
"fechaApertura": "2019-04-06",
"saldoActual": 15396,
"persona": {
"apellidoPaterno": "PRUEBAP96",
"apellidoMaterno": "PRUEBAM96",
"primerNombre": "JUAN96",
"fechaNacimiento": "1980-04-05",
"domicilio": {
"direccion": "PASADISO ENCONTRADO 96",
"coloniaPoblacion": "MONTEVIDEO",
"delegacionMunicipio": "GUSTAVO A MADERO",
"ciudad": "CIUDAD DE MÉXICO",
"estado": "CDMX",
"CP": "7730"
}
}
} - Status Code 403
{"folio": "1600100",
"tipoProducto": "R",
"tipoContrato": "TC",
"frecuenciaPago": "M",
"diasAtraso": 27,
"numeroCuenta": "3000100",
"fechaApertura": "2019-04-10",
"saldoActual": 15400,
"persona": {
"apellidoPaterno": "PRUEBAP100",
"apellidoMaterno": "PRUEBAM100",
"primerNombre": "JUAN100",
"fechaNacimiento": "1980-04-09",
"domicilio": {
"direccion": "PASADISO ENCONTRADO 100",
"coloniaPoblacion": "MONTEVIDEO",
"delegacionMunicipio": "GUSTAVO A MADERO",
"ciudad": "CIUDAD DE MÉXICO",
"estado": "CDMX",
"CP": "7730"
}
}
} - Status Code 404
{"folio": "1600101",
"tipoProducto": "R",
"tipoContrato": "TC",
"frecuenciaPago": "M",
"diasAtraso": 27,
"numeroCuenta": "3000101",
"fechaApertura": "2019-04-11",
"saldoActual": 15401,
"persona": {
"apellidoPaterno": "PRUEBAP101",
"apellidoMaterno": "PRUEBAM101",
"primerNombre": "JUAN101",
"fechaNacimiento": "1980-04-10",
"domicilio": {
"direccion": "PASADISO ENCONTRADO 101",
"coloniaPoblacion": "MONTEVIDEO",
"delegacionMunicipio": "GUSTAVO A MADERO",
"ciudad": "CIUDAD DE MÉXICO",
"estado": "CDMX",
"CP": "7730"
}
}
} - Status Code 429
{"folio": "1600102",
"tipoProducto": "R",
"tipoContrato": "TC",
"frecuenciaPago": "M",
"diasAtraso": 27,
"numeroCuenta": "3000102",
"fechaApertura": "2019-04-12",
"saldoActual": 15402,
"persona": {
"apellidoPaterno": "PRUEBAP102",
"apellidoMaterno": "PRUEBAM102",
"primerNombre": "JUAN102",
"fechaNacimiento": "1980-04-11",
"domicilio": {
"direccion": "PASADISO ENCONTRADO 102",
"coloniaPoblacion": "MONTEVIDEO",
"delegacionMunicipio": "GUSTAVO A MADERO",
"ciudad": "CIUDAD DE MÉXICO",
"estado": "CDMX",
"CP": "7730"
}
}
} - Status Code 500
{"folio": "1600103",
"tipoProducto": "R",
"tipoContrato": "TC",
"frecuenciaPago": "M",
"diasAtraso": 27,
"numeroCuenta": "3000103",
"fechaApertura": "2019-04-13",
"saldoActual": 15403,
"persona": {
"apellidoPaterno": "PRUEBAP103",
"apellidoMaterno": "PRUEBAM103",
"primerNombre": "JUAN103",
"fechaNacimiento": "1980-04-12",
"domicilio": {
"direccion": "PASADISO ENCONTRADO 103",
"coloniaPoblacion": "MONTEVIDEO",
"delegacionMunicipio": "GUSTAVO A MADERO",
"ciudad": "CIUDAD DE MÉXICO",
"estado": "CDMX",
"CP": "7730"
}
}
} - Status Code 503
{"folio": "1600104",
"tipoProducto": "R",
"tipoContrato": "TC",
"frecuenciaPago": "M",
"diasAtraso": 27,
"numeroCuenta": "3000104",
"fechaApertura": "2019-04-14",
"saldoActual": 15404,
"persona": {
"apellidoPaterno": "PRUEBAP104",
"apellidoMaterno": "PRUEBAM104",
"primerNombre": "JUAN104",
"fechaNacimiento": "1980-04-13",
"domicilio": {
"direccion": "PASADISO ENCONTRADO 104",
"coloniaPoblacion": "MONTEVIDEO",
"delegacionMunicipio": "GUSTAVO A MADERO",
"ciudad": "CIUDAD DE MÉXICO",
"estado": "CDMX",
"CP": "7730"
}
}
}
'
required: true
schema:
$ref: '#/definitions/NoAportantesPeticion'
responses:
'200':
description: 'OK'
schema:
$ref: '#/definitions/Respuesta'
'400':
description: "BAD REQUEST"
schema:
$ref: "#/definitions/Errores"
examples:
application/json:
errores:
- codigo: "400.1"
mensaje: "El campo \"{Campo}\" no puede estar vacío."
'404':
description: "NOT FOUND"
schema:
$ref: "#/definitions/Errores"
examples:
application/json:
errores:
- codigo: "404.1"
mensaje: "No se encontraron resultados."
'401':
description: "UNAUTHORIZED"
schema:
$ref: "#/definitions/Errores"
examples:
application/json:
errores:
- codigo: "401.1"
mensaje: 'Acceso no autorizado, x-api-key no válida.'
- codigo: '401.2'
mensaje: 'Acceso no autorizado.'
- codigo: '401.3'
mensaje: 'Acceso no autorizado, no tiene el producto asociado.'
- codigo: '401.4'
mensaje: 'Acceso no autorizado, no tiene acceso al recurso.'
'403':
description: "FORBIDDEN"
schema:
$ref: "#/definitions/Errores"
examples:
application/json:
errores:
- codigo: "403.1"
mensaje: "No se pudo autenticar, x-signature no es válida"
'429':
description: 'TOO MANY REQUESTS'
schema:
$ref: '#/definitions/Errores'
examples:
application/json:
errores:
- codigo: '429.1'
mensaje: 'Se han enviado demasiadas solicitudes. Se debe esperar antes de realizar una nueva solicitud.'
'500':
description: "INTERNAL SERVER ERROR"
examples:
application/json:
errores:
- codigo: "500.1"
mensaje: "Ocurrió un problema, inténtelo nuevamente más tarde."
schema:
$ref: "#/definitions/Errores"
'503':
description: 'SERVICE UNAVAILABLE'
examples:
application/json:
errores:
- codigo: "503.1"
mensaje: "Servicio no disponible."
schema:
$ref: "#/definitions/Errores"
definitions:
CatalogoContrato:
type: 'string'
description: ' | Clave | Descripción |
| AA | Arrendamiento automotriz |
| CA | Compra de automóvil |
| FI | Fianza |
| TC | Tarjeta de crédito |
| LC | Línea de crédito |
| AR | Arrendamiento |
| PP | Préstamo personal |
| BR | Bienes raíces |
| TG | Tarjeta garantizada |
| CC | Crédito consumo |
| HV | Hipotecario o vivienda |
| ND | No disponible |
| TS | Tarjeta de servicios |
| TD | Tarjeta departamental |
| AM | Aparatos / Muebles |
| AV | Aviación |
| BL | Bote / Lancha |
| CO | Consolidación |
| EQ | Equipo |
| FT | Factoraje |
| HE | Préstamo tipo Home Equity |
| MC | Mejoras a la casa |
| OT | Otros (Multiples créditos) |
| ED | Editorial |
| VR | Vehículo recreativo |
| NG | Préstamo no garantizado |
| PG | Préstamo garantizado |
| SH | Segunda hipoteca |
| PE | Préstamo para estudiante |
| NC | Desconocido |
| HB | Hipotecario bancario |
| AB | Automotriz bancario |
| PB | Préstamo personal bancario |
| UI | Uso interno |
| PM | Préstamo empresarial |
| AE | Física actividad empresarial |
| PC | Procampo |
| BC | Banca comunal |
| GS | Grupo solidario |
| FF | Fodeo fira |
| CP | Crédito personal al consumo |
| CF | Crédito fiscal |
| PQ | Préstamo quirografario |
| CM | Comunicaciones |
| PN | Préstamo de nómina |
'
minLength: 2
maxLength: 2
enum:
- 'AA'
- 'AB'
- 'AE'
- 'AM'
- 'AR'
- 'AV'
- 'BC'
- 'BL'
- 'BR'
- 'CA'
- 'CC'
- 'CF'
- 'CM'
- 'CO'
- 'CP'
- 'ED'
- 'EQ'
- 'FF'
- 'FI'
- 'FT'
- 'GS'
- 'HB'
- 'HE'
- 'HV'
- 'LC'
- 'MC'
- 'NC'
- 'ND'
- 'NG'
- 'OT'
- 'PB'
- 'PC'
- 'PE'
- 'PG'
- 'PM'
- 'PN'
- 'PP'
- 'PQ'
- 'SH'
- 'TC'
- 'TD'
- 'TG'
- 'TS'
- 'UI'
- 'VR'
CatalogoFrecuenciaPago:
type: 'string'
description: ' | Clave | Descripción |
| N | No determinado |
| E | Semestral |
| B | Bimestral |
| M | Mensual |
| Q | Quincenal |
| A | Anual |
| V | Variable |
| C | Catorcenal |
| T | Trimestral |
| S | Semanal |
| D | Deducción de salario |
| R | Pago mínimo para cuentas revolventes |
| U | Una sola exhibición |
'
minLength: 1
maxLength: 1
enum:
- 'A'
- 'B'
- 'C'
- 'D'
- 'E'
- 'M'
- 'N'
- 'Q'
- 'R'
- 'S'
- 'T'
- 'U'
- 'V'
CatalogoEstadoCivil:
type: 'string'
description: '| Clave | Descripción |
|---|
| D | Divorciado |
| L | Unión libre |
| C | Casado |
| S | Soltero |
| V | Viudo |
| E | Separado |
'
maxLength: 1
enum:
- 'D'
- 'L'
- 'C'
- 'S'
- 'V'
- 'E'
CatalogoNacionalidad:
type: 'string'
description: 'Debe contener la clave de la nacionalidad del consumidor los valores posibles son los siguientes:
| Clave | Nacionalidad | País |
|---|
| AD | Andorra | Andorra |
| AF | Afgana | Afganistán |
| AG | Antigua y Barbado | Antigua y Barbado |
| AI | Anguila | Anguila |
| AN | Albania | Albania |
| AO | Angola | Angola |
| AS | Ascensión | Ascensión |
| AT | Argentina | Argentina |
| AU | Australiana | Australia |
| AW | Árabe | Arabia |
| AX | Azores | Azores |
| BB | Barbados | Barbados |
| BD | Bangladesh | Bangladesh |
| BE | Belga | Bélgica |
| BF | Burkina | Burkina |
| BG | Búlgara | Bulgaria |
| BH | Bahrein | Bahrein |
| BI | Burundi | Burundi |
| BJ | Benin | Benin |
| BK | Birmania | Birmania |
| BM | Bután | Bután |
| BN | Brunei | Brunei |
| BO | Boliviana | Bolivia |
| BR | Brasileño | Brasil |
| BS | Bahamas | Bahamas |
| BU | Bermudas | Bermudas |
| BW | Botswana | Botswana |
| BX | Bosnia Herzegovina | Bosnia Herzegovina |
| BZ | Belice | Belice |
| CB | Colombiana | Colombia |
| CC | Córcega | Córcega |
| CD | Chad | Chad |
| CF | Rep. Central Africana | Rep. Central Africana |
| CG | Congo | Congo |
| CH | Liechtenstein | Liechtenstein |
| CI | Islas Caimán | Islas Caimán |
| CJ | Comoros | Comoros |
| CL | Chilena | Chile |
| CM | Camerunés | Camerún |
| CN | Canadiense | Canadá |
| CP | China | China (Pekín) |
| CS | República Checa Eslovaca | República Checa Eslovaca |
| CU | Cariacou | Cariacou |
| CV | Cabo Verde | Cabo Verde |
| CY | Chipre | Chipre |
| DF | Austriaca | Austria |
| DJ | Djibouti | Djibouti |
| DK | Danés | Dinamarca |
| DM | Dominicana | Dominicana |
| DO | Dominicana | República Dominicana |
| DW | Alemana | Alemania |
| DZ | Argelia | Argelia |
| EC | Ecuatoriana | Ecuador |
| EG | Egipcia | Egipto |
| EM | Timor Oriental | Timor Oriental |
| ES | Española | España |
| ET | Etiopia | Etiopia |
| FA | Islas Falkland (Malvinas) | Islas Falkland (Malvinas) |
| FE | Islas Faroe | Islas Faroe |
| FI | Finlandia | Finlandia |
| FJ | Fiji | Fiji |
| FP | Polinesia | Polinesia |
| FR | Francesa | Francia |
| GB | Gabón | Gabón |
| GD | Granada | Granada |
| GE | Groenlandia | Groenlandia |
| GF | Guayana Francesa | Guayana Francesa |
| GH | Ghana | Ghana |
| GI | Gibraltar | Gibraltar |
| GM | Gambia | Gambia |
| GN | Guinea | Guinea |
| GP | Guadalupe | Guadalupe |
| GQ | Guinea Ecuatorial | Guinea Ecuatorial |
| GR | Griega | Grecia |
| GT | Guatemalteca | Guatemala |
| GW | Guinea Bissau | Guinea Bissau |
| GX | República De Georgia | República De Georgia |
| GY | Guyana | Guyana |
| HA | Haitiana | Haití |
| HK | Hong Kong | Hong Kong |
| HN | Hondureña | Honduras |
| HR | Cubano | Cuba |
| HU | Húngara | Húngara |
| HX | Croata | Croacia |
| IB | India | India |
| IC | Costa De Marfil | Costa De Marfil |
| IE | Irlandesa | Irlandesa |
| IF | Indonesia | Indonesia |
| IG | Israelí | Israelí |
| IQ | Iraquí | Iraquí |
| IR | Iraní | Iraní |
| IS | Islandia | Islandia |
| IT | Italiano | Italiano |
| JM | Jamaicano | Jamaicano |
| JO | Jordano | Jordano |
| JP | Japonesa | Japonesa |
| KA | Kampuchea | Kampuchea |
| KE | Kenya | Kenya |
| KI | Kiribati | Kiribati |
| KN | San Cristóbal De Neváis | San Cristóbal De Neváis |
| KR | Corea Del Sur | Corea Del Sur |
| KW | Kuwait | Kuwait |
| KX | Corea Del Norte | Corea Del Norte |
| LB | Libanes | Libanes |
| LC | Santa Lucia | Santa Lucia |
| LE | Islas De Sotavento | Islas De Sotavento |
| LK | Sri Lanka | Sri Lanka |
| LO | Laos | Laos |
| LR | Liberia | Liberia |
| LS | Lesotho | Lesotho |
| LT | Lituania | Lituania |
| LU | Luxemburgo | Luxemburgo |
| LV | Libia | Libia |
| LX | Letonia | Letonia |
| MC | Mongolia | Mongolia |
| MD | Madeira | Madeira |
| MG | Madagascar | Madagascar |
| MH | Macedonia | Macedonia |
| MJ | Macao | Macao |
| MK | Montserrat | Montserrat |
| ML | Mali | Mali |
| MM | Montenegro | Montenegro |
| MP | Sao Tome y Principado | Sao Tome y Principado |
| MQ | Martinico | Martinico |
| MR | Mauritania | Mauritania |
| MT | Malta | Malta |
| MU | Mauricio | Mauricio |
| MV | Maldivas | Maldivas |
| MW | Malawi | Malawi |
| MX | Mexicana | México |
| MY | Malasia | Malasia |
| MZ | Mozambique | Mozambique |
| NA | Nauru | Nauru |
| ND | No Definido | No Definido |
| NI | Nicaragua | Nicaragua |
| NL | Holandesa | Holanda |
| NN | Antillas Holandesas | Antillas Holandesas |
| NO | Noruega | Noruega |
| NP | Nepal | Nepal |
| NR | Nigeriano | Nigeria |
| NW | Nueva Caledonia | Nueva Caledonia |
| NZ | Nueva Zelandia | Nueva Zelandia |
| OA | Katar | Katar |
| OM | Omán | Omán |
| PG | Papúa Nueva Guinea | Papúa Nueva Guinea |
| PH | Filipinas | Filipinas |
| PK | Pakistán | Pakistán |
| PL | Polaco | Polonia |
| PM | Panameño | Panamá |
| PS | Islas Pitcairn | Islas Pitcairn |
| PT | Portugués | Portugal |
| PU | Peruana | Perú |
| PY | Paraguayo | Paraguay |
| RC | Marroquí | Marruecos |
| RE | Islas Reunión | Islas Reunión |
| RO | Rumana | Rumania |
| RU | Rusa | Rusia |
| RW | Ruanda | Ruanda |
| SA | Saudí Árabe | Arabia Saudita |
| SB | Sudan | Sudan |
| SE | Sueco | Suecia |
| SF | San Vencen y Las Granadas | San Vencen y Las Granadas |
| SH | Santa Helena | Santa Helena |
| SI | Islas Salmon | Islas Salmon |
| SN | Senegal | Senegal |
| SO | Somalia | Somalia |
| SP | San Pierre y Miquelón | San Pierre y Miquelón |
| SR | Surinam | Surinam |
| SS | San Kitts | San Kitts |
| ST | Islas Santa Cruz | Islas Santa Cruz |
| SU | Estonia | Estonia |
| SV | Salvadoreña | El Salvador |
| SW | Suiza | Suiza |
| SX | Serbia | Serbia |
| SY | Siria | Siria |
| SZ | Swazilandia | Swazilandia |
| TA | Tonga | Tonga |
| TC | Turcos e Islas Caicos | Turcos e Islas Caicos |
| TD | Tristán De Cunha | Tristán De Cunha |
| TG | Togo | Togo |
| TH | Tailandia | Tailandia |
| TR | Turca | Turquía |
| TT | Trinidad y Tobago | Trinidad y Tobago |
| TU | Túnez | Túnez |
| TV | Tuvala | Tuvala |
| TW | Taiwán | Taiwán |
| TZ | Tanzania | Tanzania |
| UA | Ucraniano | Ucrania |
| UG | Uganda | Uganda |
| UK | Reino Unido | Reino Unido |
| UM | Árabe | Emiratos Árabes Unidos |
| US | Estadounidense | Estados Unidos |
| UY | Uruguayo | Uruguay |
| VC | Ciudad Del Vaticano | Ciudad Del Vaticano |
| VE | Venezolana | Venezuela |
| VG | Islas Vírgenes Inglesas | Islas Vírgenes Inglesas |
| VN | Vietnami | Vietnam |
| VU | Vanuatu | Vanuatu |
| WS | Samoa Oeste | Samoa Oeste |
| WT | Gales / Isla Futura | Gales / Isla Futura |
| XN | Eslovenia | Eslovenia |
| YE | Yemen (Del Sur) | Yemen (Del Sur) |
| YS | Yemen (Del Norte) | Yemen (Del Norte) |
| ZA | Sudafricana | África Del Sur |
| ZM | Zambia | Zambia |
| ZR | Zaire | Zaire |
| ZW | Zimbabwe | Zimbabwe |
| Clave | Estado |
| AGS | Aguascalientes |
| BC | Baja California Norte |
| BCS | Baja California Sur |
| CAMP | Campeche |
| CDMX | Ciudad de México |
| CHIS | Chiapas |
| CHIH | Chihuahua |
| COAH | Coahuila |
| COL | Colima |
| DF | Distrito Federal |
| DGO | Durando |
| GTO | Guanajuato |
| GRO | Guerrero |
| HGO | Hidalgo |
| JAL | Jalisco |
| MEX | México |
| MICH | Michoacán |
| MOR | Morelos |
| NAY | Nayarit |
| NL | Nuevo León |
| OAX | Oaxaca |
| PUE | Puebla |
| QRO | Querétaro |
| QROO | Quintana Roo |
| SLP | San Luis Potosí |
| SIN | Sinaloa |
| SON | Sonora |
| TAB | Tabasco |
| TAMP | Tamaulipas |
| TLAX | Tlaxcala |
| VER | Veracruz |
| YUC | Yucatán |
| ZAC | Zacatecas |
'
minLength: 2
maxLength: 4
example: 'JAL'
enum:
- 'AGS'
- 'BC'
- 'BCS'
- 'CAMP'
- 'COAH'
- 'COL'
- 'CHIS'
- 'CHIH'
- 'DF'
- 'CDMX'
- 'DGO'
- 'GTO'
- 'GRO'
- 'HGO'
- 'JAL'
- 'MEX'
- 'MICH'
- 'MOR'
- 'NAY'
- 'NL'
- 'OAX'
- 'PUE'
- 'QRO'
- 'QROO'
- 'SLP'
- 'SIN'
- 'SON'
- 'TAB'
- 'TAMP'
- 'TLAX'
- 'VER'
- 'YUC'
- 'ZAC'
CatalogoResidencia:
type: 'integer'
format: 'int32'
description: 'Descripciones para los valores enviados en este campo por Círculo de Crédito. | Clave | Descripción |
|---|
| 1 | Propietario |
| 2 | Renta |
| 3 | Vive con familiares |
| 4 | Vivienda hipotecada |
| 5 | No disponible |
'
minimum: 0
maximum: 1
enum:
- 1
- 2
- 3
- 4
- 5
CatalogoSexo:
type: 'string'
description: '| Clave | Descripción |
|---|
| F | Femenino |
| M | Masculino |
'
maxLength: 1
enum:
- 'F'
- 'M'
CatalogoTipoAsentamiento:
description: ' | Clave | Tipo de Asentamiento |
| 0 | Pendiente por actualizar |
| 1 | Aereopuerto |
| 2 | Barrio |
| 3 | Base naval |
| 4 | Campamento |
| 5 | Centro |
| 6 | Centro urbano |
| 7 | Colonia |
| 8 | Condominio |
| 9 | Congregación |
| 10 | Conjunto habitacional |
| 11 | Conjunto habitacional residencial |
| 12 | Conjunto habitacional urbano |
| 13 | Conjunto popular |
| 14 | Conjunto residencial |
| 15 | Conjunto urbano |
| 16 | Conjunto urbano popular |
| 17 | Ejido |
| 18 | Escuela |
| 19 | Estación de radio |
| 20 | Ex-hacienda |
| 21 | Ex-rancho |
| 22 | Fábrica |
| 23 | Finca |
| 24 | Fraccionamiento |
| 25 | Fraccionamiento industrial |
| 26 | Fraccionamiento residencial |
| 27 | Granja |
| 28 | Hacienda |
| 29 | Ingenio |
| 30 | Junta auxilia |
| 31 | Modulo habit |
| 32 | Parque |
| 33 | Parque industrial |
| 34 | Cuadrilla |
| 35 | Poblado comercial |
| 36 | Pueblo |
| 37 | Rancho |
| 38 | Residencial |
| 39 | Villa |
| 40 | Unidad habit |
| 41 | Zona federal |
| 42 | Zona habitac |
| 43 | Zona industrial |
| 44 | Zona residencial |
| 45 | Zona urbana |
| 46 | Zona urbana |
| 47 | Campo milita |
| 48 | Vivienda popular |
| 49 | Club de golf |
| 50 | Cooperativa |
| 51 | Ciudad |
| 52 | Oficina de comercio |
| 53 | Gran usuario |
| 54 | Zona comercial |
| 55 | Zona rural |
'
example: '28'
enum:
- '0'
- '1'
- '2'
- '3'
- '4'
- '5'
- '6'
- '7'
- '8'
- '9'
- '10'
- '11'
- '12'
- '13'
- '14'
- '15'
- '16'
- '17'
- '18'
- '19'
- '20'
- '21'
- '22'
- '23'
- '24'
- '25'
- '26'
- '27'
- '28'
- '29'
- '30'
- '31'
- '32'
- '33'
- '34'
- '35'
- '36'
- '37'
- '38'
- '39'
- '40'
- '41'
- '42'
- '43'
- '44'
- '45'
- '46'
- '47'
- '48'
- '49'
- '50'
- '51'
- '52'
- '53'
- '54'
- '55'
CatalogoExclusion:
type: 'string'
maxLength: 2
description: 'Código de rechazo en caso de no ser procesado el registro| Clave | Descripción |
|---|
| E0 | Días de mora está fuera del rango para el producto |
| E1 | La cuenta por cobrar de un aportante no se encuentra en la base de Círculo |
| E2 | La persona no se encuentra en la base de Círculo. |
| E3 | El expediente no contiene ningún crédito no excluido |
'
enum:
- 'E0'
- 'E1'
- 'E2'
- 'E3'
CatalogoProducto:
type: 'string'
minLength: 1
maxLength: 1
description: '| Clave | Descripción |
|---|
| R | Consumo revolvente |
| F | Pagos fijos |
| O | Otro |
'
enum:
- 'R'
- 'F'
- 'O'
CatalogoTipoDomicilio:
type: 'string'
description: '| Clave | Descripción |
|---|
| N | Negocio |
| O | Domicilio del otorgante |
| C | Casa |
| P | Apartado postal |
| E | Empleo |
'
maxLength: 1
example: 'C'
enum:
- 'N'
- 'O'
- 'C'
- 'P'
- 'E'
DomicilioPeticion:
type: 'object'
required:
- 'direccion'
- 'coloniaPoblacion'
- 'delegacionMunicipio'
- 'CP'
- 'ciudad'
- 'estado'
description: 'Datos del domicilio de la persona a consultar'
properties:
direccion:
type: 'string'
description: 'Reportar el nombre de la calle, número exterior, número interior. Deben considerarse avenida,cerrada, manzana, lote, edificio,departamento etc. Debe contener por lo menos dos cadenas de caracteres para que el registro sea válido, de lo contrario el registro será rechazado.'
minLength: 1
maxLength: 80
example: 'HIDALGO 32'
coloniaPoblacion:
type: 'string'
description: 'Reportar la colonia a la cual pertenece la dirección contenida en el elemento dirección.'
minLength: 1
maxLength: 65
example: 'CENTRO'
delegacionMunicipio:
type: 'string'
description: 'Reportar la delegación o municipio a la cual pertenece la dirección contenida en el elemento Dirección.'
minLength: 1
maxLength: 65
example: 'LA BARCA'
ciudad:
type: 'string'
description: 'Reportar la ciudad a la cual pertenece la dirección contenida en el elemento Dirección.'
minLength: 1
maxLength: 65
example: 'BENITO JUAREZ'
estado:
$ref: '#/definitions/CatalogoEstados'
CP:
type: 'string'
description: 'El código postal reportado debeestar compuesto por 5 dígitos. Para que el código postal sea válido deberá corresponder al estado reportado.'
minLength: 5
maxLength: 5
example: '47917'
fechaResidencia:
type: 'string'
description: 'Debe de reportarse la fecha desde cuando el consumidor vive en la dirección reportada.'
format: 'yyyy-MM-dd'
example: "2018-12-21"
numeroTelefono:
type: 'string'
description: 'Debe de contener una longitud mínima de 5 caracteres. Cada carácter debe ser un número de 0-9, si se ingresa cualquier otro carácter el registro será rechazado.'
maxLength: 20
example: '5512345678'
tipoDomicilio:
$ref: '#/definitions/CatalogoTipoDomicilio'
tipoAsentamiento:
$ref: '#/definitions/CatalogoTipoAsentamiento'
AportantesPeticion:
description: 'Datos para generar Vant/age.'
type: 'object'
required:
- 'folio'
- 'numeroCuenta'
- 'diasAtraso'
properties:
folio:
type: 'string'
description: 'Número consecutivo único del registro, asignado por el cliente'
minLength: 1
maxLength: 50
numeroCuenta:
type: 'string'
description: 'No. del crédito, es asignado por el otorgante, todas las cuentas son únicas'
minLength: 1
maxLength: 50
diasAtraso:
type: 'integer'
format: 'int32'
description: 'No. de días que ha estado vencido el crédito'
minLength: 1
maxLength: 10
tipoContrato:
$ref: '#/definitions/CatalogoContrato'
example:
folio: '12345'
numeroCuenta: "34232343"
diasAtraso: 10
tipoContrato: 'PP'
NoAportantesPeticion:
description: 'Datos para generar Vant/age.'
type: 'object'
required:
- 'folio'
- 'tipoContrato'
- 'frecuenciaPago'
- 'diasAtraso'
- 'tipoProducto'
- 'persona'
- 'numeroCuenta'
- 'fechaApertura'
- 'saldoActual'
properties:
folio:
type: 'string'
description: 'Número consecutivo único del registro, asignado por el cliente'
minLength: 1
maxLength: 50
tipoProducto:
$ref: '#/definitions/CatalogoProducto'
tipoContrato:
$ref: '#/definitions/CatalogoContrato'
frecuenciaPago:
$ref: '#/definitions/CatalogoFrecuenciaPago'
diasAtraso:
type: 'integer'
format: 'int32'
description: 'No. de días que ha estado vencido el crédito'
minLength: 1
maxLength: 10
persona:
$ref: '#/definitions/PersonaPeticion'
numeroCuenta:
type: 'string'
description: 'No. de crédito, es asignado por el otorgante, todas las cuentas son únicas, dato para validar la relación jurídica.'
minLength: 1
maxLength: 50
fechaApertura:
type: 'string'
description: 'Fecha apertura del crédito (por defecto yyyy-MM-dd), dato para validar la relación jurídica.'
format: 'yyyy-MM-dd'
minLength: 10
maxLength: 10
saldoActual:
type: 'number'
format: 'float'
description: 'Saldo Actual del crédito, dato para validar la relación jurídica.'
minLength: 1
maxLength: 15
example:
folio: '12345'
diasAtraso: 10
tipoProducto: "R"
tipoContrato: "PP"
frecuenciaPago: "S"
persona:
primerNombre: 'JUAN'
apellidoPaterno: "LOPEZ"
apellidoMaterno: "FUENTES"
fechaNacimiento: "1978-03-23"
nacionalidad: "MX"
RFC: "RFCC870909765"
CURP: "RFCC870909MMCNRC02"
domicilio:
direccion: "FLORES 23"
coloniaPoblacion: "JARDINES"
ciudad: "MEXICO"
estado: "JAL"
delegacionMunicipio: "VALLE DE CHALCO"
CP: "65432"
numeroTelefono: "5409098765"
numeroCuenta: "12344323"
fechaApertura: "2006-09-01"
saldoActual: 100
PersonaPeticion:
description: 'Datos generales de la persona a consultar.'
type: 'object'
required:
- 'primerNombre'
- 'apellidoPaterno'
- 'apellidoMaterno'
- 'fechaNacimiento'
- 'domicilio'
properties:
apellidoPaterno:
type: 'string'
description: 'Apellido paterno de la persona. Sin abreviaturas o iniciales'
minLength: 1
maxLength: 30
apellidoMaterno:
type: 'string'
description: 'Apellido materno de la persona'
minLength: 1
maxLength: 30
apellidoAdicional:
type: 'string'
description: 'Apellido adicional de la persona, si tuviere'
maxLength: 30
primerNombre:
type: 'string'
description: 'Primer nombre de la persona'
minLength: 1
maxLength: 50
segundoNombre:
type: 'string'
description: 'Segundo nombre de la persona'
maxLength: 50
fechaNacimiento:
type: 'string'
description: 'Fecha de nacimiento de la persona, en el formato especificado (por defecto yyyy-MM-dd)'
format: 'yyyy-MM-dd'
minLength: 10
maxLength: 10
example: '1978-03-23'
RFC:
type: 'string'
maxLength: 13
description: 'RFC con homoclave de la persona'
CURP:
type: 'string'
maxLength: 18
description: 'CURP de la persona, emitida por RENAPO'
nacionalidad:
$ref: '#/definitions/CatalogoNacionalidad'
residencia:
$ref: '#/definitions/CatalogoResidencia'
estadoCivil:
$ref: '#/definitions/CatalogoEstadoCivil'
sexo:
$ref: '#/definitions/CatalogoSexo'
claveElectorIFE:
type: 'string'
description: 'La clave de elector que se encuentra en el IFE/INE.'
maxLength: 20
example: '000000000000'
numeroDependientes:
type: 'integer'
format: 'int32'
description: 'Número de personas que dependen de la persona.'
maxLength: 2
fechaDefuncion:
type: 'string'
description: 'Fecha de nacimiento de la persona, en el formato especificado (por defecto yyyy-MM-dd)'
format: 'yyyy-MM-dd'
example: '9999-01-01'
domicilio:
$ref: '#/definitions/DomicilioPeticion'
example:
primerNombre: 'JUAN'
apellidoPaterno: "LOPEZ"
apellidoMaterno: "FUENTES"
fechaNacimiento: "1978-03-23"
nacionalidad: "MX"
RFC: "RFCC870909765"
CURP: "RFCC870909MMCNRC02"
domicilio:
direccion: "FLORES 23"
coloniaPoblacion: "JARDINES"
ciudad: "MEXICO"
estado: "JAL"
delegacionMunicipio: "VALLE DE CHALCO"
CP: "65432"
numeroTelefono: "5409098765"
Respuesta:
type: 'object'
properties:
folio:
type: 'string'
description: 'Número consecutivo único del registro, asignado por el cliente'
example: "13231213"
folioConsulta:
type: 'string'
description: 'Número consecutivo único del registro, asignado por Circulo de Crédito'
example: "12244332"
numeroCuenta:
type: 'string'
description: 'No. de Crédito, es asignado por el otorgante, todas las cuentas son únicas'
example: '234234234'
calificacion:
type: 'string'
description: 'Calificación de acuerdo a la probabilidad de pasar al siguiente tramo en los próximos 30 días'
example: 'A'
maxLength: 1
enum:
- 'A'
- 'B'
- 'C'
- 'D'
- 'E'
- 'F'
codeExclusion:
$ref: "#/definitions/CatalogoExclusion"
Error:
type: "object"
properties:
codigo:
type: "string"
example: "400.1"
mensaje:
type: "string"
example: "Descripcion del error"
Errores:
type: "object"
properties:
errores:
type: "array"
items:
$ref: "#/definitions/Error"