apyhub-logo
FusionPlatformAPI CatalogPricingBlog

Validate SWIFT/BIC API

Data Validation#bic#validate
ApyHub
ApyHub
verified icon
5 atoms
Base tier

About

This Utility API lets you validate BIC/SWIFT code.
BIC/SWIFT code validation is an important component of financial transactions in applications, and helps to ensure that transactions are accurate, reliable, and processed in a timely manner.
In applications that involve financial transactions, such as online banking or money transfers, it is important to ensure that the BIC/SWIFT code entered by the user is accurate and valid. This is because the BIC/SWIFT code is used to identify the bank or financial institution involved in the transaction, and any error or inaccuracy in the code could result in the transaction being rejected or delayed.

API Playground

API Documentation

validate bic
POST
https://api.apyhub.com/validate/bic

Request example

1
curl --location --request POST 'https://api.apyhub.com/validate/bic' \
2
--header 'apy-token: {{token}}' \
3
--header 'Content-Type: application/json' \
4
--data '{
5
    "bic":"ABNANL2A"
6
}'
Method: POST
Content Type: application/json
Request Body
AttributeTypeMandatoryDescription
bicstringYesThe BIC/SWIFT code that you want to validate. for example: ABNANL2A
Sample Response
A successful request returns the data object with below mentioned attributes if the code is valid. If its not not then it will simply returns data: false
1
{
2
    "data": {
3
        "valid": true,
4
        "bank_code": "ABNA",
5
        "country_code": "NL",
6
        "location_code": "2A",
7
        "branch_code": null
8
    }
9
}

HTTP Response Codes

The method may return one of the following HTTP status codes:
Status CodeDescription
200The request was successful.
400Invalid input.
401Required authentication information is either missing or not valid for the resource.
500If any unexpected error occurs while processing the request.

Authentication

All API requests to ApyHub services need to be authenticated. Currently we support tokens or basic authentication mechanisms. You can generate and view your existing credentials from your workspace settings (on the left side of the navbar) and go to “API Keys".
Points to note:
  • Credential secrets are generated on the fly and are not stored in plain text, so on generating a credential please save the secrets somewhere safe.
  • Use the apy-token as the header parameter to pass the token.
  • Use the Authorization header to send the basic authentication credentials.

Error codes

1
{
2
  "error": {
3
    "code": 105,
4
    "message": "Invalid URL"
5
  }
6
}
To search for a specific error code, enter the code in the search box below. Alternatively, you can click on the button to view a complete list of all error codes.
Table of contents
AboutAPI PlaygroundAPI DocumentationAuthenticationError codesRelated Utility APIsRelated Articles