Skip to main content
POST
/
v2
/
AgreementGet
Get user agreement
curl --request POST \
  --url http://localhost:3000/v2/AgreementGet \
  --header 'Content-Type: application/json' \
  --header 'X-Bunker-Token: <api-key>' \
  --data '
{
  "mode": "login",
  "identity": "<string>",
  "brief": "<string>",
  "request_metadata": {}
}
'
{
  "status": "ok",
  "agreement": {}
}

Documentation Index

Fetch the complete documentation index at: https://docs.databunker.org/llms.txt

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

Authorizations

​
X-Bunker-Token
string
header
required

API token for authentication

Body

application/json
​
mode
enum<string>
required

Mode of user identification

Available options:
login,
token,
email,
phone,
custom
​
identity
string
required

User identifier corresponding to the mode

​
brief
string
required

Unique identifier of the legal basis/agreement

​
request_metadata
object

Additional metadata for the request

Response

200 - application/json

User agreement retrieved successfully

​
status
string
Example:

"ok"

​
agreement
object

Agreement information