Check if Secondary Reference Data (SRD) is required

Submits a pre-check to assess whether the destination account requires additional Secondary Reference Data
(e.g., a building society roll number) before a full CoP name check can be performed.

If response.data.secondaryReferenceDataRequired is true, pass the returned confirmationOfPayeeCheckId as
secondaryReferenceCheckId, and the customer-provided roll number as secondaryReference, in the subsequent CoP name check.

Body Params

The SRD requirement check details

Request body for checking whether Secondary Reference Data (SRD) is required before a CoP check

string
required

The Mercury-assigned reference returned from POST /api/v1/client. Must belong to an Active client under your distributor account.

string
required

The destination UK account number

string
required

The destination UK sort code. Must be exactly 6 digits.

string
required

The currency code. Must be from GET /api/v1/lookup/cop-eligible-currencies, e.g. GBP.

string
required

The country code of the destination account. Must be from GET /api/v1/lookup/cop-eligible-countries, e.g. GB.

Responses

401

Missing or invalid x-api-key, x-nonce or Authorization signature. The response has no body.

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json