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. El alcance se define con permissions (modelo vigente) o con scopes (modelo legacy). Son mutuamente excluyentes: una API key solo puede tener uno de los dos.

idstringrequired

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

Example: ak_sandbox_1B2M2Y8AsgTpgAmY7PhCfg

labelstringrequired

Etiqueta descriptiva de la API key

Example: Banking App

environmentstringrequired

Entorno al que pertenece la API key

Possible values: [sandbox, production]

Example: sandbox

expires_atdate-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_atdate-timenullable

Fecha y hora del último uso de la API key

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

scopesstring[]deprecated

Legacy. Lista de patrones de endpoints permitidos. Usa permissions en su lugar. Mutuamente excluyente con permissions: una API key solo puede tener uno de los dos.

Cada patrón hace match exacto de path, salvo que termine en /*, en cuyo caso también permite cualquier ruta anidada bajo ese prefijo. Si el path solicitado no está cubierto por ninguno de los scopes, la API responde 401 con type: authentication_error.

Example: ["/v1/identities/*","/v1/disclosure_requests/*"]

permissionsApiPermission[]

Permisos asignados a la API key. Modelo vigente para definir su alcance de acceso. Mutuamente excluyente con scopes: una API key solo puede tener uno de los dos.

Possible values: [api.read, api.write, api.manage, agreements.api.read, api_keys.api.read, api_keys.api.write, api_keys.api.manage, auth_attempts.api.read, auth_requests.api.read, auth_requests.api.write, auth_requests.api.manage, branches.api.read, branches.api.write, branches.api.manage, company_users.api.read, company_users.api.write, company_users.api.manage, config.api.manage, consent.api.read, consent.api.write, consent.api.config, consent.api.manage, consent_actions.api.read, consent_actions.api.write, consent_actions.api.manage, consent_commits.api.read, consent_commits.api.write, consent_commits.api.manage, consent_corrections.api.read, consent_corrections.api.write, consent_corrections.api.manage, consent_form_entries.api.read, consent_form_entries.api.write, consent_form_entries.api.manage, consent_forms.api.read, consent_forms.api.write, consent_forms.api.manage, consent_revocations.api.read, consent_revocations.api.write, consent_revocations.api.manage, consent_templates.api.read, consent_templates.api.write, consent_templates.api.manage, data_subject_requests.api.read, data_subject_requests.api.write, data_subject_requests.api.config, data_subject_requests.api.manage, disclosure.api.read, disclosure.api.write, disclosure.api.config, disclosure.api.manage, disclosure_requests.api.read, disclosure_requests.api.write, disclosure_requests.api.manage, disclosure_templates.api.read, disclosure_templates.api.write, disclosure_templates.api.manage, entities.api.read, entities.api.write, entities.api.manage, events.api.read, events.api.write, events.api.manage, exports.api.read, exports.api.write, exports.api.manage, government_check_requests.api.read, government_check_requests.api.write, government_check_requests.api.manage, identities.api.read, privacy_documents.api.read, privacy_documents.api.write, privacy_documents.api.manage, products.api.read, products.api.write, products.api.manage, reports.api.read, reports.api.write, reports.api.manage, roles.api.read, roles.api.write, roles.api.delete, roles.api.manage, signature_attempts.api.read, signature_attempts.api.write, signature_attempts.api.manage, signed_documents.api.read, third_parties.api.read, third_parties.api.write, third_parties.api.manage, taxonomy.api.read, validation_attempts.api.read, webhooks.api.read, webhooks.api.write, webhooks.api.manage, workflows.api.read, workflows.api.write, workflows.api.config, workflows.api.manage]

Example: ["consent_actions.api.read","api_keys.api.manage"]

created_atdate-timerequired

Fecha y hora de creación de la API key

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

secretstring

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

Example: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...

refresh_tokenstringnullable

Token de actualización asociado a la API key. Solo se incluye cuando la clave tiene fecha de expiración y es creado o renovado mediante la API. Debe guardarse para extender la API key una vez vencida

Example: akrt_1B2M2Y8AsgTpgAmY7PhCfg

mcp_managedboolean

Indica si la API key fue creada y es administrada por una conexión MCP.

Example: false

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",
  "permissions": [
    "consent_actions.api.read",
    "api_keys.api.manage"
  ],
  "created_at": "2024-03-20T15:30:00Z",
  "secret": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  "refresh_token": "akrt_1B2M2Y8AsgTpgAmY7PhCfg",
  "mcp_managed": false
}