Appearance
Getting Started
En 3 pasos hacés tu primer request. Los pasos 1 y 3 son idénticos para las cuatro superficies; sólo cambia el endpoint del paso 2.
1. Obtené una API Key
Las API Keys las emite el equipo desde el panel de administración. Cada key:
- tiene el prefijo
ilk_(p.ej.ilk_live_...en producción,ilk_test_...en pruebas), - se muestra una sola vez al crearse y no puede recuperarse (guardala en un lugar seguro),
- lleva asociados scopes que determinan qué superficies, modelos y fuentes podés usar.
No publiques tu API Key ni la incrustes en el frontend. En el playground la pegás vos y queda solo en tu navegador.
2. Hacé el request
bash
curl -X POST https://tu-host/api/v1/person-search/search \
-H "Authorization: Bearer ilk_live_xxx" \
-H "Content-Type: application/json" \
-d '{
"model": "PERSON_STANDARD",
"keys": { "cuit": "20111111112" }
}'bash
curl -X POST https://tu-host/api/v1/sources/igj/query \
-H "Authorization: Bearer ilk_live_xxx" \
-H "Content-Type: application/json" \
-d '{ "keys": { "cuit": "30111111119" } }'bash
curl https://tu-host/api/v1/sources \
-H "Authorization: Bearer ilk_live_xxx"bash
curl -X POST https://tu-host/api/v1/utils/email/validate \
-H "Authorization: Bearer ilk_live_xxx" \
-H "Content-Type: application/json" \
-d '{ "email": "persona@empresa.com.ar" }'bash
curl -X POST https://tu-host/api/v1/utils/phone/validate \
-H "Authorization: Bearer ilk_live_xxx" \
-H "Content-Type: application/json" \
-d '{ "phone": "011 15-5555-1234", "defaultCountry": "AR", "validationLevel": "LOCAL" }'También podés autenticarte con la cabecera x-api-key: ilk_live_xxx en lugar de Authorization.
3. Leé la respuesta
Los endpoints de resolución (Person Search y fuentes) comparten envelope:
json
{
"queryId": "dq_01J0000000000000000000EXMP",
"resolvedEntityType": "NATURAL_PERSON",
"subjects": [
{
"resolvedEntityType": "NATURAL_PERSON",
"entityRef": "ent_01J0000000000000000000EXMP",
"identity": {
"identifiers": [{ "type": "CUIT", "value": "20111111112", "country": "AR" }],
"names": [{ "kind": "FULL_NAME", "value": "Juan Ejemplo" }]
},
"score": 98.5,
"payloads": [ { "schemaRef": "golden_record.person.v1", "version": "1.0.0", "data": { } } ]
}
],
"partial": false,
"cost": { "amount": 1.0, "currency": "USD" },
"correlationId": "7f3e0c2a-4b1d-4e5f-9a8b-0c1d2e3f4a5b"
}La consulta a una fuente agrega source y trae un payload por sujeto: el de esa fuente. Las validaciones de email y teléfono devuelven su propia forma, documentada en su página.
Siguiente
- Autenticación y scopes — qué habilita cada scope.
- Búsqueda — cómo componer claves y leer resultados.
- Fuentes — qué fuentes hay y cómo consultarlas de a una.
- Probalo en el playground.
Los datos de todos los ejemplos son sintéticos. No uses datos personales reales.