# Single Request

This endpoint will perform a search with the supplied data against a bank or building society. NOTE:- This endpoint will charge when a successful request is made to a bank or building society. This endpoint will charge when a result is returned. This includes charging if the no match is found. All property fields need to be submitted with the request, if information for a specific property is not needed, it is required to pass an empty string.

Endpoint: POST /localSolutions/GB/bankVerification/search
Version: 1.10.9
Security: bearerToken

## Request fields (application/json):

  - `customerName` (string, required)
    This field is for the name on the account you are matching against with the bankAccount, sortCode and secondaryReference fields

  - `bankAccount` (string, required)
    Must be numeric and a length of 8 characters

  - `sortCode` (string, required)
    Must be numeric and a length of 6 characters

  - `accountType` (string, required)
    field must be either Business or Personal, it can not be blank or any other value

  - `secondaryReference` (string)
    Should not be used unless you have been advised to use this by a bank or building society This field will affect the results data

  - `customerReference` (string)
    Field is for text input and does not affect the search result This field can be used for filtering your past results at a later date

## Response 200 fields (application/json):

  - `supplierRequestData` (object)

  - `supplierRequestData.customerName` (string)
    Name of the customer queried with the the supplier

  - `supplierRequestData.bankAccount` (string)
    Bank account number queried with the the supplier

  - `supplierRequestData.sortCode` (string)
    Sort code queried with the the supplier

  - `supplierRequestData.accountType` (string)
    Type of account - Business or Personal

  - `supplierRequestData.secondaryReference` (string)
    Secondary reference queried with the the supplier

  - `customerReference` (string)
    Your Customer reference as described in the requestBody

  - `supplierResponse` (object)

  - `supplierResponse.customerName` (string)
    Name of the customer returned by the supplier

  - `supplierResponse.bankAccount` (string)
    The bank account number returned by the supplier

  - `supplierResponse.sortCode` (string)
    The sort code returned by the supplier

  - `supplierResponse.returnedCustomerName` (string)
    A potential name of the customer returned by the supplier when the result is a close match returned by the supplier

  - `supplierResponse.result` (boolean)
    Whether the result is a match or not a match returned by the supplier

  - `supplierResponse.resultText` (string)
    A detailed result returned by the supplier, this includes details of a close match

  - `supplierResponse.nameMatchResult` (string)
    The name match result returned by the supplier. Values are "No Match", "Full" or "Close"

  - `supplierResponse.accountTypeResult` (boolean)
    The account type match returned by the supplier. When 'nameMatchResult' is "Full" or "Close" and this is false then this indicates that the "accountType" provided does not match

  - `supplierResponse.reasonCode` (string)
    A reason code returned by the supplier

  - `requestDatetime` (string)
    The date time this request was returned

  - `requestId` (string)
    A unique reference to your request used for querying the below endpoints where {id} is required

  - `sortCodeDetails` (object)
    Provides additional information about the returned sort code. This property is only returned when an additional service line is active. Please contact your account manager for details about availability and enabling this feature.

  - `sortCodeDetails.sortCode` (string)
    The sorting code of the bank office.

  - `sortCodeDetails.bankName` (string)
    The full name of the owning bank.

  - `sortCodeDetails.branchName` (string)
    The full bank office title.

  - `sortCodeDetails.address` (object)

  - `sortCodeDetails.address.simpleValue` (string)
    The full address details of the bank office.

  - `sortCodeDetails.address.country` (string)
    The country the bank office resides in.

  - `sortCodeDetails.address.postCode` (string)
    Postal code for the full address line.

  - `sortCodeDetails.telephone` (string)
    The telephone number of the bank office.

  - `sortCodeDetails.bicCode` (string)
    The Bank Identifier Code (BIC) for the bank office.

  - `sortCodeDetails.chapsBicCode` (string)
    A CHAPS BIC code refers to the Bank Identifier Code (BIC) of a financial institution that is a participant in the CHAPS payment system in the United Kingdom.

  - `sortCodeDetails.paymentTypes` (object)

  - `sortCodeDetails.paymentTypes.chaps` (boolean)
    Indicates whether the bank office accepts CHAPS Sterling payments.

  - `sortCodeDetails.paymentTypes.cncccPayment` (boolean)
    Indicates whether the bank office participates in ICS and accepts C&CCC payments.

  - `sortCodeDetails.paymentTypes.directDebit` (boolean)
    Indicates whether the bank office accepts output of electronic DDIs.

  - `sortCodeDetails.paymentTypes.fasterPayments` (boolean)
    Indicates whether the bank office accepts FPS payments.

  - `sortCodeDetails.paymentTypes.paymentBacs` (boolean)
    Indicates whether the bank office accepts Bacs payments.

## Response 400 fields (application/json):

  - `correlationId` (string)
    A unique ID assigned to this request.

  - `message` (string)

  - `details` (string)
    Provides further information on why the request was rejected

## Response 401 fields (application/json):

  - `error` (string)

## Response 403 fields (application/json):

  - `message` (string)
    Example: "Access forbidden"

## Response 404 fields (application/json):

  - `correlationId` (string)
    A unique ID assigned to this request.

  - `message` (string)

  - `details` (string)
    Provides further information on why the request was rejected