Skip to main content
POST
/
v1
/
authorizations
/
revoke
cURL
curl --request POST \
  --url https://api.nxos.io/v1/authorizations/revoke \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "grantingOrganizationId": "<string>",
  "authorizedOrganizationId": "<string>",
  "type": "LOA",
  "reason": "<string>"
}
'
{
  "object": "authorization",
  "grantingOrganizationId": "org_a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4",
  "authorizedOrganizationId": "org_b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5",
  "type": "LOA",
  "status": "REVOKED",
  "signedAt": "2025-12-01T10:30:00.000Z",
  "revokedAt": "2026-03-15T14:30:00.000Z",
  "revokedReason": "Client off-boarded",
  "createdAt": "2025-12-01T10:30:00.000Z",
  "updatedAt": "2026-03-15T14:30:00.000Z"
}

Documentation Index

Fetch the complete documentation index at: https://docs.nxos.io/llms.txt

Use this file to discover all available pages before exploring further.

Headers

Authorization
string
required

Bearer token. Format: Bearer <api_key>

Idempotency-Key
string

Unique key per logical operation. UUID v4 recommended. Max 255 characters.

Body

application/json

Request body for POST /v1/authorizations/revoke.

grantingOrganizationId
string
required

Organization that granted the authorization (the customer).

authorizedOrganizationId
string
required

Organization that received the authorization (the broker / platform).

type
enum<string>
required

Type of grant to revoke. Currently always LOA.

Available options:
LOA
reason
string

Optional free-form reason for the revocation (max 500 chars). Stored on the row for audit.

Response

The request has succeeded.

A cross-org authorization grant between two organizations.

object
enum<string>
required

Object type. Always authorization.

Available options:
authorization
grantingOrganizationId
string
required

Organization that granted the authorization (the customer).

authorizedOrganizationId
string
required

Organization that received the authorization (the broker / platform).

type
enum<string>
required

Type of grant. Currently always LOA.

Available options:
LOA
status
enum<string>
required

Current status — PENDING, ACTIVE, or REVOKED.

Available options:
PENDING,
ACTIVE,
REVOKED
signedAt
string
required

ISO 8601 timestamp when the granter signed. null when the row is still PENDING.

revokedAt
string
required

ISO 8601 timestamp when the grant was revoked. null until revocation.

revokedReason
string | null
required

Optional free-form reason captured at revocation time. null when not provided.

createdAt
string
required

ISO 8601 timestamp when the row was first created (usually when the LOA invitation was issued).

updatedAt
string
required

ISO 8601 timestamp of the most recent state change (signing or revocation).