Remove Customer Requirement¶
Overview¶
Use the RemoveCustomerRequirement endpoint to remove a previously added verification requirement from a customer. This
allows you to cancel pending requirements that are no longer needed.
Endpoint¶
POST https://api.brij.fi/brij.core.v1.partner.Service/RemoveCustomerRequirement
Request Body¶
{
"customerId": "cust_abc123xyz",
"attestationType": "VALIDATED_ID_DOCUMENT"
}
Or for data requirements:
{
"customerId": "cust_abc123xyz",
"dataType": "RESIDENTIAL_ADDRESS"
}
Request Parameters¶
| Field | Type | Required | Description |
|---|---|---|---|
customerId |
string | Yes | Unique identifier for the customer |
dataType |
string | No1 | Type of data requirement to remove (see Data Types) |
attestationType |
string | No1 | Type of attestation requirement to remove (see below) |
Data Types¶
For the full list of supported data types, see Data Types.
Attestation Types¶
For the full list of supported attestation types, see Attestation Types.
Response¶
{}
A successful response returns an empty object, indicating the requirement was removed.
Error Responses¶
| Status Code | Description |
|---|---|
400 |
Invalid request parameters |
401 |
Invalid or missing API key |
404 |
Customer, partner, or requirement not found |
500 |
Internal server error |
Examples¶
Example 1: Remove ID Document Verification Requirement¶
Remove a pending identity document verification requirement:
{
"customerId": "cust_abc123xyz",
"attestationType": "VALIDATED_ID_DOCUMENT"
}
Example 2: Remove Proof of Address Requirement¶
Remove a pending residential address data requirement:
{
"customerId": "cust_abc123xyz",
"dataType": "RESIDENTIAL_ADDRESS"
}
Example 3: Remove AML Check Requirement¶
Remove a pending anti-money laundering check requirement:
{
"customerId": "cust_abc123xyz",
"attestationType": "AML_CHECK"
}
Example 4: Remove Source of Funds Requirement¶
Remove a pending source of funds data requirement:
{
"customerId": "cust_abc123xyz",
"dataType": "SOURCE_OF_FUNDS"
}