abstract-api/openapi/abstract-api-phone-intelligence.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
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
openapi: 3.0.3
info:
  title: Abstract API - Phone Intelligence API
  description: Identify carrier, line type, validity, location, and get deep insights including line status, VoIP detection, and risk scoring for any phone number globally.
  version: 1.0.0
  contact:
    url: https://www.abstractapi.com/
  x-generated-from: documentation
servers:
  - url: https://phoneintelligence.abstractapi.com/v1
    description: Phone Intelligence API v1
security:
  - apiKey: []
tags:
  - name: Phone Intelligence
    description: Phone number validation and intelligence
paths:
  /:
    get:
      operationId: getPhoneIntelligence
      summary: Abstract API Get Phone Intelligence
      description: Validate a phone number and retrieve carrier, location, line type, VoIP status, and risk information.
      tags:
        - Phone Intelligence
      parameters:
        - name: api_key
          in: query
          description: Your unique API key for the Phone Intelligence API.
          required: true
          schema:
            type: string
          example: abc123def456
        - name: phone
          in: query
          description: The phone number to validate and analyze.
          required: true
          schema:
            type: string
          example: '+14155552671'
        - name: country
          in: query
          description: ISO 3166-1 alpha-2 country code to specify the phone number origin.
          required: false
          schema:
            type: string
          example: US
      responses:
        '200':
          description: Successful phone intelligence response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PhoneIntelligenceResponse'
              examples:
                getPhoneIntelligence200Example:
                  summary: Default getPhoneIntelligence 200 response
                  x-microcks-default: true
                  value:
                    phone: '+14155552671'
                    valid: true
                    country:
                      code: US
                      name: United States
                      prefix: '1'
                    location: California
                    type: mobile
                    carrier: Verizon
                    is_voip: false
                    risk_score: 12
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Unauthorized - invalid API key
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '429':
          description: Rate limit exceeded
          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:
    PhoneIntelligenceResponse:
      type: object
      description: Phone number intelligence response
      properties:
        phone:
          type: string
          description: The phone number in E.164 format
          example: '+14155552671'
        valid:
          type: boolean
          description: Whether the phone number is valid
          example: true
        country:
          $ref: '#/components/schemas/PhoneCountry'
        location:
          type: string
          description: Geographic location of the phone number
          example: California
        type:
          type: string
          description: Line type
          example: mobile
          enum:
            - mobile
            - landline
            - voip
            - toll_free
            - premium_rate
            - shared_cost
            - unknown
        carrier:
          type: string
          description: Carrier or service provider
          example: Verizon
        is_voip:
          type: boolean
          description: Whether the number is a VoIP number
          example: false
        risk_score:
          type: integer
          description: Risk score from 0 (low risk) to 100 (high risk)
          example: 12
    PhoneCountry:
      type: object
      properties:
        code:
          type: string
          description: ISO 3166-1 alpha-2 country code
          example: US
        name:
          type: string
          description: Country name
          example: United States
        prefix:
          type: string
          description: International dialing prefix
          example: '1'
    ErrorResponse:
      type: object
      properties:
        message:
          type: string
          example: The provided API key is invalid
        error:
          type: string
          example: invalid_api_key