GET
/
aa
/
consent
{
  "consent_verification_id": "abc12345",
  "consent_ref_id": 67890,
  "consent_redirect_url": "https://example.com/redirect",
  "status": "SUCCESS",
  "customer_identifiers": [
    {
      "type": "MOBILE",
      "value": "9876543210"
    }
  ],
  "consent_start": "2024-01-01T00:00:00Z",
  "consent_expiry": "2024-12-31T23:59:59Z",
  "fi_from": "2024-01-01T00:00:00Z",
  "fi_to": "2024-12-31T23:59:59Z",
  "redirect_url": "https://example.com/redirect",
  "consent_mode": "STORE",
  "consent_type": [
    "PROFILE",
    "SUMMARY",
    "TRANSACTION"
  ],
  "fi_types": [
    "DEPOSIT"
  ],
  "data_life_expiry": "2024-01-07",
  "filter": [
    {
      "type": "TRANSACTION_AMOUNT",
      "operator": "LESS_THAN",
      "value": "20000"
    }
  ]
}

Authorizations

x-client-id
string
header
required

Client ID. You can find your ID in the Merchant Dashboard.

x-client-secret
string
header
required

Client secret key. You can find your secret key in the Merchant Dashboard.

Headers

x-cf-signature
string

Send the signature if IP is not whitelisted

Query Parameters

It is the unique ID created by Cashfree Payments that you receive in the response of Consent Request API.

It is the unique ID you created to identify the verification request.

Response

200 - application/json
customer_identifiers
object[]
data_life_expiry
string
fi_from
string
fi_to
string
fi_types
string[]
filter
object[]
redirect_url
string
status
enum<string>
Available options:
PENDING,
PROCESSING,
SUCCESS,
PAUSED,
EXPIRED,
REVOKED,
REJECTED