Skip to content
Agent Authority

Disclosure Request

POST
/api/disclosures/requests
curl --request POST \
  --url https://agentauthority.org/api/disclosures/requests \
  --header 'Content-Type: application/json' \
  --header 'idempotency-key: example' \
  --data '{ "agent_id": "example", "recipient_owner_id": "example", "requested_fields": [ "jurisdiction" ] }'

Parameters

Section titled “Parameters”

Header Parameters

Section titled “Header Parameters”
idempotency-key
required
Idempotency-Key
string
>= 8 characters <= 128 characters

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
DisclosureRequest
object
agent_id
required
Agent Id
string
recipient_owner_id
Any of:
string
requested_fields
Requested Fields
Array<string>
<= 2 items
Allowed values: jurisdiction owner_kind

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json

Example generated

example

422

Section titled “422”

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context
object

Example generated

{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example",
      "input": "example",
      "ctx": {}
    }
  ]
}