Instituciones
Los bancos y entidades que encargan avalúos, y cómo se usan al crear uno.
Las entidades que encargan avalúos. Cada una tiene dos identificadores:
| Campo | Qué es | Dónde lo usas |
|---|---|---|
codigo | Código del API, p. ej. BBVA. No sale del PDF; solo cambia si se edita con PATCH /v1/catalogos/instituciones/{id} (scope catalogos:write). | Lo devuelve POST /v1/avaluos/procesar en institution. La bandeja de control (GET /v1/control/inbox) y GET /v1/metricas/flujo lo devuelven en institucion, y GET /v1/metricas/flujo lo acepta como filtro ?institucion=. GET /v1/avaluos/{folio} no lo incluye. |
clave | Clave de 6 dígitos del catálogo de Banxico, p. ej. 040012. Puede ser null. | Es el valor del campo 1.16 del PDF. |
Consultar
/v1/institucionesavaluos:readCatálogo de instituciones válidas
curl "$API_URL/v1/instituciones" -H "x-api-key: $API_KEY"[
{ "clave": "040012", "codigo": "BBVA", "nombre": "BBVA MEXICO" },
{ "clave": "040014", "codigo": "SANTANDER", "nombre": "SANTANDER" }
]Los nombres vienen del catálogo de Banxico, que los corta a 15 caracteres: por eso aparecen
nombres como HIPOTECARIA FED.
Cómo se usa al crear un avalúo
Con POST /v1/avaluos/procesar se lee la clave del campo 1.16
del PDF, y es obligatoria:
- Si el campo no se encuentra:
422 INSTITUCION_NO_DETECTADA. - Si la clave no está en el catálogo o la institución está dada de baja (
activa: false):422 INSTITUCION_NO_VALIDA. Solo se aceptan las claves que devuelveGET /v1/instituciones.
En los dos casos el avalúo no se crea. Al re-subir una versión corregida
(POST /v1/avaluos/{folio}/documento) se aplican los mismos 422: la versión no se registra y
el avalúo conserva la institución que tenía. Si la versión se acepta, la institución del avalúo
pasa a ser la del campo 1.16 del PDF nuevo.
Campos del catálogo completo
GET /v1/catalogos/instituciones devuelve además:
| Campo | Tipo | Descripción |
|---|---|---|
id | UUID | Identificador para editar o dar de baja. |
tipo | financiera · otro | Tipo de entidad. |
activa | boolean | false si se dio de baja. |
created_at, updated_at | fecha | Alta y última modificación. |
Dar de alta
curl -X POST "$API_URL/v1/catalogos/instituciones" \
-H "x-api-key: $API_KEY" \
-H "Content-Type: application/json" \
-d '{"clave":"040021","codigo":"HSBC","nombre":"HSBC","tipo":"financiera"}'| Campo | Regla |
|---|---|
codigo | Obligatorio, 2 a 40 caracteres. Se guarda en mayúsculas. |
nombre | Obligatorio, al menos 2 caracteres. |
tipo | Obligatorio: financiera u otro. |
clave | Opcional, de 1 a 6 dígitos. Se completa con ceros a la izquierda. |
| HTTP | code | Causa |
|---|---|---|
409 | CODIGO_DUPLICADO | Ya existe ese codigo. |
409 | CLAVE_DUPLICADA | Ya existe esa clave. |
404 | INSTITUCION_NO_ENCONTRADA | Al editar o dar de baja, el id no existe. |
Fichas completas en la referencia.