Retrieve consent

GEThttps://api.omise.co/consent

Retrieve consent information for the account. This endpoint returns the current consent status and configuration details for the authenticated account.

---

Request Parameters

No parameters required for this endpoint.

---

Responses

200

Successful request

Returns the consent object with status and configuration details.

Consent object contains:

• object - String value "consent"
• id - Consent identifier
• location - API endpoint path "/consent"
• consented - Boolean indicating if consent has been given
• consented_at - Timestamp when consent was given (ISO 8601)
• created_at - Consent record creation timestamp (ISO 8601)

400

Bad request

Request validation failed. Check the error message for details.

Common causes:

• Invalid request format
• Malformed request headers

401

Unauthorized

Authentication failed. Invalid or missing API key.

Common causes:

• Missing Authorization header
• Invalid secret key
• Using public key instead of secret key
• Incorrect HTTP Basic Auth format

404

Not found

Consent record not found for the account.

Common causes:

• Consent has not been configured for the account
• Account does not have consent requirements

5xx

Server error

Server-side error occurred. These are rare but should be handled gracefully.

How to handle:

• Retry the request with exponential backoff
• Check status.omise.co for service incidents
• See Error Handling for detailed guidance

---

Code samples

cURL

curl https://api.omise.co/consent \
  -u skey_test_5xuy4w91xqz7d1w9u0t:

Ruby

require 'omise'

Omise.api_key = 'skey_test_5xuy4w91xqz7d1w9u0t'

consent = Omise::Consent.retrieve

Python

import omise

omise.api_secret = 'skey_test_5xuy4w91xqz7d1w9u0t'

consent = omise.Consent.retrieve()

Node.js

const omise = require('omise')({
  secretKey: 'skey_test_5xuy4w91xqz7d1w9u0t'
});

const consent = await omise.consent.retrieve();

PHP

<?php
define('OMISE_SECRET_KEY', 'skey_test_5xuy4w91xqz7d1w9u0t');

$consent = OmiseConsent::retrieve();

Java

Client client = new Client.Builder()
    .secretKey("skey_test_5xuy4w91xqz7d1w9u0t")
    .build();

Consent consent = client.consent().get();

C#

var client = new Client("skey_test_5xuy4w91xqz7d1w9u0t");

var consent = await client.Consent.Get();

Go

client, _ := omise.NewClient(
    "pkey_test_5xuy4w91xqz7d1w9u0t",
    "skey_test_5xuy4w91xqz7d1w9u0t",
)

consent, _ := client.Consent().Get()

---

🔑API Credentials

▼

Try it out

Your IP: ...Loading...