post
https://in.staging.decentro.tech/v2/financial_services/data/pull
This API is used to fetch customer data using their name and mobile or an ID document
Important Note
Please use only Staging Credentials on each API Reference page to test the APIs directly from our Documentation.
API Endpoints
| Environment | Endpoint |
|---|---|
| Staging / Sandbox | https://in.staging.decentro.tech/v2/financial_services/data/pull |
| Production | https://in.decentro.tech/v2/financial_services/data/pull |
Decentro provides the capability for businesses to fetch data of their customers using mobile number and full name to simplify onboarding and reduce drop-offs.
Please note that not always the customer might be found in our database.
Supported Documents
Supported documents for document_type parameter are Aadhaar, Driving_License, PAN, Passport, VoterID.
Refer here for Data Pull Documentation
Response Key Description
| Key | Data Type | Description |
|---|---|---|
decentroTxnId | String | Transaction ID generated by Decentro for tracking the request. |
status | String | Overall status of the request (e.g., "SUCCESS" or "FAILURE"). |
responseCode | String | System-defined response code indicating the result of the request (e.g., "S00000" for success). |
message | String | Message providing additional information about the API response status. |
data | Object | Primary container holding the detailed response payload. |
reportOrderNumber | String | Unique reference number generated for the data report retrieval. |
personalInfo | Object | Container for personal demographic information of the individual. |
fullName | String | Full name of the individual as per Bureau records. |
dob | String | Date of birth of the individual (Format: YYYY-MM-DD) |
gender | String | Gender of the individual :["Male", "Female"] |
totalIncome | String | Total income value associated with the individual (if available in records else "") |
occupation | String | Occupation of the individual (if available in records else "") |
age | String | Age of the individual derived from date of birth. |
phoneInfo | Array of Objects | List of phone records associated with the individual. |
phoneInfo.sequence | String | Unique sequence identifier for each phone record. |
phoneInfo.reportedDate | String | Date on which the phone number was reported or last updated (Format: YYYY-MM-DD) |
phoneInfo.typeCode | String | Type of phone number (H = Home, M = Mobile, T = Telephone/Other). |
phoneInfo.number | String | 10-digit Phone number associated with the individual. |
emailInfo | Array of Objects | List of email records associated with the individual. |
emailInfo.sequence | String | Unique sequence identifier for each email record. |
emailInfo.reportedDate | String | Date on which the email address was reported or last updated (Format: YYYY-MM-DD) |
emailInfo.emailAddress | String | Email ID associated with the individual. |
identityInfo | Object | Container for government-issued identity details linked to the individual. |
identityInfo.panNumber | Array of Objects | List containing PAN details. |
identityInfo.panNumber.idNumber | String | Permanent Account Number (PAN) of the individual. |
identityInfo.panNumber.sequence | String | Sequence identifier for the PAN record. |
identityInfo.passportNumber | Array of Objects | List containing passport numbers linked to the individual. |
identityInfo.passportNumber.idNumber | String | Passport number of the individual. |
identityInfo.passportNumber.sequence | String | Sequence identifier for the passport record. |
identityInfo.drivingLicense | Array | List containing driving license details (empty if not available). |
identityInfo.voterId | Array | List containing voter ID details (empty if not available). |
identityInfo.aadhaarNumber | Array of Objects | List containing masked Aadhaar numbers linked to the individual. |
identityInfo.aadhaarNumber.idNumber | String | Masked Aadhaar number (partially hidden for security compliance). |
identityInfo.aadhaarNumber.sequence | String | Sequence identifier for the Aadhaar record. |
identityInfo.rationCard | Array | List containing ration card details (empty if not available). |
identityInfo.otherId | Array | List containing any additional identity documents (empty if not available). |
addressInfo | Array of Objects | List of address records associated with the individual. |
addressInfo.sequence | String | Unique sequence identifier for each address record. |
addressInfo.address | String | Full address of the individual as available in records. |
addressInfo.state | String | State corresponding to the address. |
addressInfo.type | String | Address classification (e.g., Primary, Permanent). |
addressInfo.postal | String | Postal code (PIN code) of the address. |
addressInfo.reportedDate | String | Date on which the address was reported or last updated (Format: YYYY-MM-DD) |
responseKey | String | Response identifier indicating successful/failed customer data pull. |
Response Key Mapping
The below mentioned response keys will be passed as part of the Customer Data Pull API.
| Response Key | Scenario |
|---|---|
success_customer_data_pull | Customer data pulled successfully |
error_decentro_error | Internal Server Error. Kindly retry the transaction after sometime |
error_provider_error | Unexpected response received from the underlying provider. |
error_empty_module_secret | An empty module secret was passed. |
error_invalid_module_secret | An invalid module secret was passed |
error_empty_consent | Consent cannot be null or empty. Hint: consent (boolean) |
error_invalid_consent | Consent should be of boolean type. Hint: consent (boolean) |
error_false_consent | Consent cannot be false. Hint: consent (boolean) |
error_malformed_request | A malformed JSON request was passed. |
error_unsanitized_values | Unsanitized values detected for key(s) |
error_empty_name | Name cannot be null or empty. Hint: name (string). |
error_duplicate_reference_id | Duplicate Request Reference ID |
error_module_credits_exhausted | You have consumed your credits. Please connect with our team on [email protected] for credit renewal. |
error_unauthorized_module | Authorization failed for accessing the module |
error_no_subscription_found | No subscription details found for this module. Please subscribe this module to access the APIs. |
error_empty_mobile | Mobile Number cannot be null or empty. Hint: mobile (string) |
error_unauthorized_provider | Provider Not Authorized For Company |
error_unexpected_response | Unexpected response received from underlying provider. |