MUmuralpay
Utilities

Validate a Bre-B key

Changed on

Validate a Bre-B key and return linked holder information if found.

get/api/utilities/validations/bre-b

Request

Query parameters

keyValuestring required
Example:@CB123456789

The Bre-B key value to validate

Response

Validation result: success with holder details when key is found, or failure when not found

OR

Example response

{
  "holderIdNumber": "123456789",
  "holderName": "Juan Pérez"
}

Changes

  • 65aadbefe527Revision changes
    • warning

      added the new SignedAgreementRequiredException enum value to the response property for the response status

    • info

      added the non-success response with the status