abstract-api/openapi/abstract-api-iban-validation.yaml at main · api-evangelist/abstract-api · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
openapi: 3.0.3
info:
  title: Abstract API - IBAN Validation API
  description: Determine the validity and details of International Bank Account Numbers (IBANs), including bank name, account type, and country code.
  version: 1.0.0
  contact:
    url: https://www.abstractapi.com/
  x-generated-from: documentation
servers:
  - url: https://ibanvalidation.abstractapi.com/v1
    description: IBAN Validation API v1
security:
  - apiKey: []
tags:
  - name: IBAN Validation
    description: IBAN number validation operations
paths:
  /:
    get:
      operationId: validateIBAN
      summary: Abstract API Validate IBAN
      description: Validate an IBAN number and retrieve bank details, account type, and country information.
      tags:
        - IBAN Validation
      parameters:
        - name: api_key
          in: query
          required: true
          description: Your unique API key for the IBAN Validation API.
          schema:
            type: string
          example: abc123def456
        - name: iban
          in: query
          required: true
          description: The IBAN to validate.
          schema:
            type: string
          example: GB82WEST12345698765432
      responses:
        '200':
          description: IBAN validation result
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IBANValidationResponse'
              examples:
                validateIBAN200Example:
                  summary: Default validateIBAN 200 response
                  x-microcks-default: true
                  value:
                    iban: GB82WEST12345698765432
                    is_valid: true
                    country:
                      code: GB
                      name: United Kingdom
                    bank:
                      bank_name: Westpac Banking Corporation
                      bank_code: WEST
                      bic: WESTGB22
                    account_number: 98765432
                    check_digits: '82'
                    sepa_member: true
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  securitySchemes:
    apiKey:
      type: apiKey
      in: query
      name: api_key
  schemas:
    IBANValidationResponse:
      type: object
      description: IBAN validation and enrichment response
      properties:
        iban:
          type: string
          description: The IBAN submitted for validation
          example: GB82WEST12345698765432
        is_valid:
          type: boolean
          description: Whether the IBAN is valid
          example: true
        country:
          type: object
          properties:
            code:
              type: string
              description: ISO 3166-1 alpha-2 country code
              example: GB
            name:
              type: string
              description: Country name
              example: United Kingdom
        bank:
          type: object
          properties:
            bank_name:
              type: string
              description: Name of the bank
              example: Westpac Banking Corporation
            bank_code:
              type: string
              description: Bank identifier code within the IBAN
              example: WEST
            bic:
              type: string
              description: Bank Identifier Code (BIC/SWIFT)
              example: WESTGB22
        account_number:
          type: string
          description: Account number extracted from the IBAN
          example: '98765432'
        check_digits:
          type: string
          description: Check digits from the IBAN
          example: '82'
        sepa_member:
          type: boolean
          description: Whether the country is a SEPA member
          example: true
    ErrorResponse:
      type: object
      properties:
        message:
          type: string
          example: The provided API key is invalid
        error:
          type: string
          example: invalid_api_key