Referencia de la API

Uso y export

Consumo mensual por validador y export CSV de sesiones.

Dos endpoints de lectura para conciliar consumo: un resumen mensual y un export CSV con las sesiones del mes.

Consumo del mes

GET/v1/usageAPI key · usage:read
CampoTipoRequeridoDescripción
monthstringnoMes en formato YYYY-MM (por ejemplo 2026-08). Si no lo mandás, el mes en curso. Un formato distinto devuelve 422.
curl -sS "$KYCAR_API/v1/usage?month=2026-08" \
  -H "Authorization: Bearer $KYCAR_API_KEY"
{
  "object": "usage",
  "month": "2026-08",
  "sessions_created": 1284,
  "tokens_consumed": 14124,
  "validators": {}
}
CampoTipoRequeridoDescripción
objectstringsiempreConstante "usage".
monthstringsiempreEl mes efectivamente consultado.
sessions_createdintegersiempreSesiones creadas en el mes, de los dos modos.
tokens_consumedintegersiempreTokens presupuestados por esas sesiones.
validatorsobjectsiempreEjecuciones por tipo de validador. Ver la nota de abajo.

Un mes sin actividad devuelve 200 con los contadores en cero, no 404.


Export CSV de sesiones

GET/v1/usage/exportAPI key · usage:read
CampoTipoRequeridoDescripción
monthstringYYYY-MM. A diferencia de /v1/usage, acá es obligatorio.
curl -sS "$KYCAR_API/v1/usage/export?month=2026-08" \
  -H "Authorization: Bearer $KYCAR_API_KEY" \
  -o kycar-usage-2026-08.csv

Devuelve text/csv; charset=utf-8 con Content-Disposition: attachment; filename="kycar-usage-2026-08.csv".

fecha,sesion,proyecto,modo,estado,validadores
2026-08-19T14:03:11.482Z,vs_01K2M4P6R8T0V2X4Z6B8D0F2H4,prj_01J9Z2K3M4N5P6Q7R8S9T0V1W2,live,approved,consent|document_ar|face_liveness
2026-08-19T15:41:02.913Z,vs_01K2M5Q7S9U1W3Y5A7C9E1G3J5,prj_01J9Z2K3M4N5P6Q7R8S9T0V1W2,live,rejected,consent|document_ar
CampoTipoColumnaDescripción
fechaISO 86011Momento de creación de la sesión.
sesionstring2Id de la sesión, vs_….
proyectostring3Id del proyecto, prj_….
modostring4live o test.
estadostring5Estado de la sesión al momento del export.
validadoresstring6Tipos de paso ejecutados, en orden, separados por |.

Límite

Un mes con más de 2000 sesiones devuelve 422: el export en línea tiene una cota dura. Si tu volumen la supera, escribinos y lo resolvemos con un export asíncrono.