Block/Unblock customer
Block Types
-
PERMANENT_BLOCK: Customer cannot be unblocked - however, customer can opt-in to be re-eKYC-ed (Reinitiate Add Customer API w/ the same customerHashID)
-
TEMPORARY_BLOCK: If the provided reason is not the same as the spec
{ "status": "BAD_REQUEST", "message": "Invalid Reason Provided", "errors": [ "Reason is not valid to Temporarily Block Customer" ] }
Example Success Message Response
{
"status": "OK",
"message": "Customer has been Blocked Temporarily",
"errors": []
}
Unblocking
Customers can be unblocked after being temporarily blocked via API (that is, action=BLOCK
).
However, if BLOCK
was requested by the NIUM Compliance team, the Client/Customer cannot request to UNBLOCK
it via API.
NOTE: The Comments
field supports only 255 characters; any longer will receive the below response:
{
"status": "BAD_REQUEST",
"message": "Validation failed for input provided",
"errors": [
"Maximum length for comment is 255"
]
}
Customer Block Table Matrix
Block by | Unblock By | Permitted? |
---|---|---|
Client | Client | YES |
Client | NIUM | NO |
NIUM | NIUM | YES |
NIUM | Client | NO |
Updated 14 days ago