Register Consent API

Introduction

The Register Consent API is the first mandatory step before performing any KYC verification or personal data processing through the Attestr Platform

Before initiating a verification request, the client (acting as the Data Fiduciary) must first obtain lawful and explicit consent from the end user (the Data Principal) for the intended data processing activity. Once the consent has been collected, the client is required to register the consent with Attestr (acting as the Data Processor) using this API.

Upon successful registration, Attestr generates a unique consent id that serves as a reference for the consent transaction. This consent id must subsequently be passed in all related verification and KYC API requests to establish a valid consent trail and enable compliant data processing on the Attestr platform.

The Register Consent API helps ensure:

• Consent traceability and auditability
• Regulatory compliance for personal data processing
• Proper linkage between consent records and verification requests
• Secure and accountable KYC workflows

Every consent registration is associated with specific:

• Data categories
• Data types
• Purpose of processing
• Verification services requested
• Consent validity and metadata

Clients must ensure that the consent obtained from the Data Principal is lawful, informed, specific, and compliant with applicable data protection regulations before invoking this API.

API Details

Request

Request Body Parameters

Service Object Definition

Data Category Object Definition

Request Header Parameters

Sample Request Payload

xxxxxxxxxx

{

    "consentPurpose": "kyc_verification",

    "services": [{

        "service": "BANK_ACC"

    }],

    "consentTimestamp": "2026-05-22T00:00:00+0000",

    "consentMode": "email_otp",

    "consentType": "multi_use",

    "consentValidFrom": "2026-05-23T12:05:00+0000",

    "consentValidTill": "2026-05-23T12:07:00+0000",

    "consentReferenceId": "12341",

    "consentPrincipalUserId": "USER#1234",

    "clientDeclaration": true,

    "consentOperations": ["VERIFY","FETCH", "STORE","REPORT"],

    "consentDataCategories": [{

        "category": "personal_information",

        "values": ["name", "father_name"]

    }, {

        "category": "financial",

        "values": ["bank_account", "ifsc"]

    }],

    "clientObtainedBy": "app-1234"

}

Response

Http Status 200

Sample Response

Sample response for valid input

xxxxxxxxxx

{

    "_id": "CX3S-m5YMohWXqt7b-",

    "number": "3991-752664-7914"

}

Error Response

Error Codes

Sample Error Response

xxxxxxxxxx

{

    "httpStatusCode": 400,

    "code": 4001,

    "message": "Malformed data or missing required parameter values",

    "appError": true

}