Skip to main content
POST
https://sandbox.finhub.cloud
/
api
/
v2.1
/
customer
/
individual
/
{customerId}
/
consents
/
terms
Individual Consents API
curl --request POST \
  --url https://sandbox.finhub.cloud/api/v2.1/customer/individual/{customerId}/consents/terms \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: <content-type>' \
  --header 'User-Agent: <user-agent>' \
  --header 'X-Forwarded-For: <x-forwarded-for>' \
  --header 'X-Tenant-ID: <x-tenant-id>' \
  --data '
{
  "accepted": true,
  "version": "<string>",
  "acceptedAt": "<string>"
}
'
{
  "success": true,
  "data": {
    "consentId": "cons_12345",
    "type": "TERMS",
    "status": "ACCEPTED",
    "acceptedAt": "2024-01-15T10:30:00Z"
  }
}

Individual Consents API

APIs for managing terms, privacy, and data processing consents for individual customers.
Base URL: https://sandbox.finhub.cloud

Required Consents for Activation

Activation Prerequisite: All three consents must be accepted before customer activation.The consents must be accepted in the correct order:
  1. Terms and Conditions
  2. Privacy Policy
  3. Data Processing
1

Accept Terms and Conditions

POST /customer/individual/{customerId}/consents/termsLegal agreement for using the service.
2

Accept Privacy Policy

POST /customer/individual/{customerId}/consents/privacyData privacy and GDPR compliance.
3

Accept Data Processing

POST /customer/individual/{customerId}/consents/data-processingConsent for processing customer data.
4

Verify Activation Readiness

GET /customer/individual/{customerId}/owner/{tenantId}/activation/checkConfirms consentOk: true before attempting activation.

Available Operations

Accept Terms

POST /consents/terms

Accept Privacy

POST /consents/privacy

Accept Data Processing

POST /consents/data-processing

Accept Consent

POST /consents/{consentId}/accept

Get Consent Status

GET /consents/{consentId}/status

Accept Terms

Records acceptance of terms and conditions.
For complete details on authentication, compliance headers, and SDK implementation examples, refer to the Standard HTTP Headers reference documentation.

Request

customerId
string
required
Customer identifier
Authorization
string
required
Bearer token for authentication
X-Tenant-ID
string
required
Tenant identifier
Content-Type
string
required
Must be application/json
X-Forwarded-For
string
required
Required for Legal Compliance & AuditClient’s originating IP address captured for consent audit trailExample: 192.168.1.100
This header is legally required for consent acceptance. The IP address is permanently stored for regulatory audits and GDPR compliance.
User-Agent
string
required
Required for Legal Compliance & AuditClient application identifier captured with consent acceptanceExample: Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36
This header is legally required to track the device/browser used for consent acceptance.
accepted
boolean
required
Consent acceptance flagMust be true to accept the terms and conditions

Code Examples

curl -X POST "https://sandbox.finhub.cloud/api/v2.1/customer/individual/ff72a196-426a-4ab3-a2d3-e4c583a9bc88/consents/terms" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "X-Tenant-ID: tenant_cloudvault" \
  -H "Content-Type: application/json" \
  -H "X-Forwarded-For: 192.168.1.100" \
  -H "User-Agent: Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36" \
  -d '{
    "accepted": true
  }'
{
  "success": true,
  "data": {
    "consentId": "cons_12345",
    "type": "TERMS",
    "status": "ACCEPTED",
    "acceptedAt": "2024-01-15T10:30:00Z"
  }
}

Accept Privacy Policy

Records acceptance of privacy policy.

Request

customerId
string
required
Customer identifier
version
string
required
Version of privacy policy being accepted
acceptedAt
string
required
ISO 8601 timestamp of acceptance

Code Examples

curl -X POST "https://sandbox.finhub.cloud/api/v2.1/customer/individual/cust_12345/consents/privacy" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "X-Tenant-ID: YOUR_TENANT_ID" \
  -H "Content-Type: application/json" \
  -d '{
    "version": "1.5",
    "acceptedAt": "2024-01-15T10:31:00Z"
  }'
{
  "success": true,
  "data": {
    "consentId": "cons_12346",
    "type": "PRIVACY",
    "status": "ACCEPTED",
    "acceptedAt": "2024-01-15T10:31:00Z"
  }
}

Accept Data Processing

Records acceptance of data processing consent (GDPR compliance).

Request

customerId
string
required
Customer identifier
version
string
required
Version of data processing agreement
acceptedAt
string
required
ISO 8601 timestamp of acceptance

Code Examples

curl -X POST "https://sandbox.finhub.cloud/api/v2.1/customer/individual/cust_12345/consents/data-processing" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "X-Tenant-ID: YOUR_TENANT_ID" \
  -H "Content-Type: application/json" \
  -d '{
    "version": "1.2",
    "acceptedAt": "2024-01-15T10:32:00Z"
  }'
{
  "success": true,
  "data": {
    "consentId": "cons_12347",
    "type": "DATA_PROCESSING",
    "status": "ACCEPTED",
    "acceptedAt": "2024-01-15T10:32:00Z"
  }
}

Get Consents

Retrieves all consents for a customer.

Request

customerId
string
required
Customer identifier

Code Examples

curl -X GET "https://sandbox.finhub.cloud/api/v2.1/customer/individual/cust_12345/consents" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "X-Tenant-ID: YOUR_TENANT_ID"
{
  "success": true,
  "data": {
    "consents": [
      {
        "type": "TERMS",
        "status": "ACCEPTED",
        "version": "2.1",
        "acceptedAt": "2024-01-15T10:30:00Z"
      },
      {
        "type": "PRIVACY",
        "status": "ACCEPTED",
        "version": "1.5",
        "acceptedAt": "2024-01-15T10:31:00Z"
      },
      {
        "type": "DATA_PROCESSING",
        "status": "ACCEPTED",
        "version": "1.2",
        "acceptedAt": "2024-01-15T10:32:00Z"
      }
    ]
  }
}

TypeDescriptionRequired
TERMSTerms and conditionsYes
PRIVACYPrivacy policyYes
DATA_PROCESSINGData processing agreementYes
MARKETINGMarketing communicationsNo

Response Codes

CodeDescription
200Consent accepted/retrieved successfully
400Invalid request data
401Unauthorized
404Customer not found
500Internal server error

API Schema Reference

For the complete OpenAPI schema specification of this endpoint, including all request and response structures, see the API Schema Mapping document.