Directory. / documentación técnica

Primeros pasos

Registrar, completar un perfil, activar

Esto recorre el flujo completo de autorregistro contra la instancia en vivo en https://directory.open.dev.br. Cada solicitud a continuación es real — no existe un entorno de sandbox separado; registrarte aquí crea una institución en estado Pending hasta que pase la validación funcional.

01 Registrar

POST /register es público y limitado por IP. Crea la institución (estado Pending, aún no listada en /participants) y su primer usuario admin, y devuelve un token de sesión — mostrado una sola vez.

curl -X POST https://directory.open.dev.br/register \
  -H "Content-Type: application/json" \
  -d '{
    "organisationName": "Example Bank",
    "adminEmail": "admin@example.com",
    "adminPassword": "a-password-of-at-least-12-chars"
  }'
{
  "organisationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "sessionToken": "kuqRrmsjEllTJlH8OAHsPj6NhNq-ax2gras0IANQRgE",
  "status": "Pending"
}

02 Verificar el correo del admin

Se envía un enlace de verificación a adminEmail. Verificarlo es requisito para la activación — GET /verify-email consume el token del enlace.

curl "https://directory.open.dev.br/verify-email?token=<token-from-the-email>"

03 Completar el perfil

Configura un jwksUri y registra al menos un authorisation server con un dcrRegistrationUri — ambos se verifican en el siguiente paso. Autentícate con el token de sesión del paso 1.

curl -X PUT https://directory.open.dev.br/admin/institutions/{institutionId} \
  -H "Authorization: Bearer {sessionToken}" \
  -H "Content-Type: application/json" \
  -d '{ "jwksUri": "https://example-bank.test/jwks.json" }'

curl -X POST https://directory.open.dev.br/admin/institutions/{institutionId}/authorisation-servers \
  -H "Authorization: Bearer {sessionToken}" \
  -H "Content-Type: application/json" \
  -d '{ "dcrRegistrationUri": "https://example-bank.test/register" }'

04 Activar

POST .../activate ejecuta la validación funcional descrita en Registro y validación — una llamada mTLS real al dcrRegistrationUri y una lectura real del jwksUri. Es síncrona, idempotente, y segura para reintentar.

curl -X POST https://directory.open.dev.br/admin/institutions/{institutionId}/activate \
  -H "Authorization: Bearer {sessionToken}"

Si tiene éxito, el estado de la institución pasa a Active y aparece en GET /participants.