Sandbox

Description

The /sandbox-consent endpoint simulates sending consent status data to a pre-configured URL or an optional URL provided via a query parameter. It generates a sample transaction and sends the data using an HTTP POST request.

---

Request

HTTP Method

GET

URL

https://api.duopen.com.br/sandbox-consent

Headers

Name	Type	Description
token	string	Token for authentication*

*Request the authentication token to our support team.

Query Parameters

Name	Type	Required	Description
url	string	No	An optional URL to send the consent status data to.
event	string	Yes	The event type. Allowed values: "created", "approved", "revoked".

---

Responses

Successful Response (2xx)

• A dictionary with the status and the consent status data.

Example

{
  "status": "Data sent successfully",
  "data": {
    "type": "consent/approved",
    "document": "12345678910"
  }
}

Error Responses (4xx or 5xx)

• An error message indicating the reason for failure.

Example

{
  "detail": "Invalid event parameter. Allowed: 'created', 'approved' or 'revoked'"
}

---

How to Use

Requests with curl

You can use curl to send a GET request to this endpoint. Below are examples of how to structure your requests.

Request (without optional URL)

curl -X GET "https://sandbox-webhook.duopen.com.br/sandbox-consent?event=approved" \
-H "token: AUTH_TOKEN"

Request (with optional URL)

curl -X GET "https://sandbox-webhook.duopen.com.br/sandbox-consent?event=approved&url=https://your-optional-url.com" \
-H "token: AUTH_TOKEN"