Skip to main content
POST
/
Agent
/
Legal
/
AuthorizeAccessToId
Authorize Access To Id
curl --request POST \
  --url https://{host}/Agent/Legal/AuthorizeAccessToId \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "legalId": "<string>",
  "remoteId": "<string>",
  "authorized": true
}
'
{}

Overview

Allows the client to (pre-)authorize access to (or remove authorization to access) one of its Legal Identities to a remote party. When (if) the remote party requests the ID, the broker will return it automatically, if already authorized. If not authorized, a petition to access the identity will be sent to the client for manual approval (or rejection).

Authentication

Requires a valid JWT bearer token.

Notes

This endpoint uses the request schema notation described in Pattern matching.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
remoteId
string
required
authorized
boolean
required

Response

200 - application/json

Success

The response is of type object.