Crear una Llave Bre-b

La llave puede ser genérica de empresa o asociada a un cliente específico. Si se crea como llave de cliente, todos los campos relacionados al cliente son obligatorios.

El cuerpo del request debe estar encriptado y la respuesta también estará encriptada.

Flujo de creación

La creación es asíncrona:

  1. Se envía el request con los datos requeridos.
  2. La API valida los datos de forma síncrona.
  3. Si la validación pasa, se encola una tarea y se retorna un task_id junto con un preview de la llave generada.
  4. La llave se crea en segundo plano. Para conocer el resultado final, consulta el endpoint Obtener Estado de Tarea Asíncrona usando el task_id retornado.

Cuerpo del request (Body)

CampoTipoRequeridoDescripción
is_clientboolean✅ SíIndica si la llave es para un cliente (true) o genérica de empresa (false)
descriptionstringNoDescripción opcional para la llave
aliasstringNoAlias opcional para identificar la llave
client_namestring✅ Si is_client=trueNombre completo del cliente
client_documentstring✅ Si is_client=trueNúmero de documento del cliente
client_document_typeinteger✅ Si is_client=trueID del tipo de documento del cliente

400 — Error de validación síncrona

La API detectó un error antes de encolar la tarea. La respuesta incluirá un campo status_code indicando el problema. Causas comunes:

  • is_client=true pero faltan campos del cliente.

401 — No autorizado

La llave de API no fue enviada o es inválida.

403 — Prohibido

No tienes permisos para acceder a este recurso.

Language
Credentials
OAuth2
Response
Click Try It! to start a request and see the response here!