POST validate

iban

1 credit

Validate an IBAN (International Bank Account Number) and return country and formatted form

Endpoint

POST /api/v1/tools/validate/iban

Body Parameters

iban string required

Example

input Request

{
    "iban": "GB82 WEST 1234 5698 7654 32"
}

output Response

{
    "valid": true,
    "reason": null,
    "country": "GB",
    "formatted": "GB82 WEST 1234 5698 7654 32"
}

Response Format

HTTP/1.1 200 OK SUCCESS

{
  "success": true,
  "data": {
    "valid": true,
    "reason": null,
    "country": "GB",
    "formatted": "GB82 WEST 1234 5698 7654 32"
},
  "meta": {
    "tool": "iban",
    "credits_consumed": 1
  }
}

HTTP/1.1 422 Unprocessable Entity ERROR

{
  "success": false,
  "data": null,
  "error": {
    "code": "validation_error",
    "message": "The given data was invalid."
  }
}

Code Examples

Request Example

lightbulb Developer Tip

Credits are deducted before execution. If the upstream tool fails, credits are automatically refunded to your account.