Add Customer Requirement¶

Overview¶

Use the AddCustomerRequirement endpoint to add specific verification requirements for individual customers. This allows you to request additional data or attestations from a customer beyond what your policy rules automatically require.

Endpoint¶

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

Request Body¶

{
  "customerId": "cust_abc123xyz",
  "maxAgeDays": 365,
  "attestation": "VALIDATED_ID_DOCUMENT"
}

Or for data requirements:

{
  "customerId": "cust_abc123xyz",
  "maxAgeDays": 90,
  "data": "RESIDENTIAL_ADDRESS"
}

Request Parameters¶

Data Types¶

Request raw data from the customer. For the full list of supported data types, see Data Types.

Attestation Types¶

Request verified attestations from the customer. For the full list of supported attestation types, see Attestation Types.

Response¶

{
  "requirementId": "req_xyz789abc"
}

Error Responses¶

Examples¶

Example 1: Request ID Document Verification¶

Request a verified identity document from a customer:

{
  "customerId": "cust_abc123xyz",
  "maxAgeDays": 365,
  "attestation": "VALIDATED_ID_DOCUMENT"
}

Example 2: Request Proof of Address¶

Request residential address data:

{
  "customerId": "cust_abc123xyz",
  "maxAgeDays": 90,
  "data": "RESIDENTIAL_ADDRESS"
}

Example 3: Request AML Check¶

Request an anti-money laundering verification:

{
  "customerId": "cust_abc123xyz",
  "maxAgeDays": 30,
  "attestation": "AML_CHECK"
}

Example 4: Request Source of Funds¶

Request source of funds documentation:

{
  "customerId": "cust_abc123xyz",
  "maxAgeDays": 180,
  "data": "SOURCE_OF_FUNDS"
}

Example 5: Request Liveness Check¶

Request a liveness verification to confirm the customer is a real person:

{
  "customerId": "cust_abc123xyz",
  "maxAgeDays": 365,
  "attestation": "LIVENESS_CHECK"
}