Skip to content

Get Customer Data By ID

Overview

Use the GetCustomerDataById endpoint to retrieve a specific data record, including binary data such as images. This endpoint returns the full data content including bytes fields that are not included in the GetCustomerData response.

Endpoint

POST https://api.brij.fi/brij.core.v1.partner.Service/GetCustomerDataById

Request Body

{
  "customerDataId": "data_def456"
}

Request Parameters

Field Type Required Description
customerDataId string Yes Unique identifier for the data record

Response

{
  "customerData": {
    "id": "data_def456",
    "type": "ID_DOCUMENT",
    "isDeleted": false,
    "hash": "a1b2c3d4e5f6...",
    "createdAt": "2025-01-15T10:30:00Z",
    "idDocument": {
      "documentType": "PASSPORT",
      "documentNumber": "AB1234567",
      "issuingCountry": "USA",
      "expiryDate": "2030-01-15",
      "frontSideImage": "<base64-encoded-bytes>",
      "frontSideImageHash": "hash123...",
      "backSideImage": "<base64-encoded-bytes>",
      "backSideImageHash": "hash456..."
    }
  }
}

Response Parameters

Field Type Description
customerData object The requested customer data record

CustomerData Object

Field Type Description
id string Unique identifier for the data record
type string Type of data (see Data Types)
isDeleted boolean Whether this data has been deleted by the customer
rawData bytes Raw data bytes
hash string Hash of the data for verification
createdAt string ISO 8601 timestamp when the data was created

The actual data content is returned in a field named after the data type (e.g., email, name, idDocument). See Data Schemas for the structure of each type.

Error Responses

Status Code Description
400 Invalid request parameters
401 Invalid or missing API key
404 Customer, partner, or data not found
500 Internal server error

Examples

Example 1: Get ID Document with Images

Retrieve a specific ID document record including the document images:

{
  "customerDataId": "data_def456"
}

Example 2: Get Selfie Image

Retrieve a selfie record including the image data:

{
  "customerDataId": "data_selfie789"
}