Saltar al contenido principal

ApiKey

Las API keys permiten autenticar y autorizar el acceso a la API de Soyio. Cada API key tiene un entorno específico (sandbox o production) y puede tener un alcance limitado.

id stringrequired

Identificador único de la API key (token). Empieza con ak_sandbox_ o ak_live_ dependiendo del entorno.

Example: ak_sandbox_1B2M2Y8AsgTpgAmY7PhCfg
label stringrequired

Etiqueta descriptiva de la API key

Example: Banking App
environment stringrequired

Entorno al que pertenece la API key

Possible values: [sandbox, production]

Example: sandbox
expires_at date-timenullable

Fecha y hora de expiración de la API key. Las claves de production por defecto expiran en 90 días, las de sandbox por defecto no expiran.

Example: 2024-06-20T15:30:00Z
last_used_at date-timenullable

Fecha y hora del último uso de la API key

Example: 2024-03-20T15:30:00Z
scopes string[]required

Alcance de permisos para la API key. Lista de patrones de endpoints permitidos.

Example: ["/v1/identities/*","/v1/disclosure_requests/*"]
created_at date-timerequired

Fecha y hora de creación de la API key

Example: 2024-03-20T15:30:00Z
secret string

Token JWT secreto de la API key. Solo se incluye al momento de la creación.

Example: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...
ApiKey
{
  "id": "ak_sandbox_1B2M2Y8AsgTpgAmY7PhCfg",
  "label": "Banking App",
  "environment": "sandbox",
  "expires_at": "2024-06-20T15:30:00Z",
  "last_used_at": "2024-03-20T15:30:00Z",
  "scopes": [
    "/v1/identities/*",
    "/v1/disclosure_requests/*"
  ],
  "created_at": "2024-03-20T15:30:00Z",
  "secret": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
}