openapi: 3.0.0 info: title: Blusalt Identity Services description: Blusalt Core APIs version: 1.0.0 servers: - url: https://api.chenosis.io/blusalt/mobile/carrierVerification security: - OAuth_security_schema: [] paths: /{phoneNumber}/verify: get: tags: - Mobile Carrier Verification summary: Mobile Carrier Verification parameters: - in: path name: phoneNumber required: true description: Phone number {countrycode}{phonenumber} schema: type: string example: 918760250230 responses: 200: description: OK headers: Set-Cookie: schema: type: string example: >- adonis-session-values=62366ad42a70f82410fc07e10fec4a2fBLWkfW7vFY%2FvbYbb%2FJnJ4K04Ar%2Bul9QoteAw1We%2F%2BdVZDvBoyYyDV1vQupKl6Kl9MjU5k0n8VCbJnORx3iAwhic8%2BMUAaCe69B3PMjlABG5pFbhHGWtXnIxXq6xIK9UlpXHBGiyUwfDn4q8rUoT7A1PZ03DtvdYaXrGkddocUa0%3D; Path=/; HttpOnly X-Frame-Options: schema: type: string example: DENY X-XSS-Protection: schema: type: string example: 1; mode=block X-Content-Type-Options: schema: type: string example: nosniff X-Download-Options: schema: type: string example: noopen Content-Type: schema: type: string example: application/json; charset=utf-8 Content-Length: schema: type: integer example: '362' Date: schema: type: string example: Wed, 20 Jul 2022 11:14:46 GMT Connection: schema: type: string example: keep-alive Keep-Alive: schema: type: string example: timeout=5 content: application/json: schema: type: object example: status_code: 200 error: false message: User Info Retrieved data: valid: true number: '2347065745963' local_format: '07065745963' international_format: '+2347065745963' country_prefix: '+234' country_code: NG country_name: Nigeria (Federal Republic of) location: '' carrier: MTN Nigeria Communications Ltd line_type: mobile mno: MTN 401: description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/401' 400: description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/400' 403: description: Forbidden content: application/json: schema: $ref: '#/components/schemas/403' 404: description: Not Found content: application/json: schema: $ref: '#/components/schemas/404' 405: description: Method No Allowed content: application/json: schema: $ref: '#/components/schemas/405' 408: description: Timeout content: application/json: schema: $ref: '#/components/schemas/408' 500: description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/500' components: schemas: 400: type: object properties: statusCode: type: string example: 4000 statusMessage: type: string example: "Bad Request" SupportMessage: type: string example : "Provided phoneNumber is invalid" transactionId : type: string example : af1ab6b4-9b1c-4397-bf92-5e1de673b944 401: type: object properties: statusCode: type: string example: 4000 statusMessage: type: string example: "Unauthorized" SupportMessage: type: string example : "Please verify Authorization header" transactionId : type: string example : af1ab6b4-9b1c-4397-bf92-5e1de673b944 403: type: object properties: statusCode: type: string example: 6001 statusMessage: type: string example: "Forbidden" SupportMessage: type: string example : "Please verify the access token" transactionId : type: string example : af1ab6b4-9b1c-4397-bf92-5e1de673b944 404: type: object properties: statusCode: type: string example: 1000 statusMessage: type: string example: "Not Found" SupportMessage: type: string example : "Reousrce not found" transactionId : type: string example : af1ab6b4-9b1c-4397-bf92-5e1de673b944 405: type: object properties: statusCode: type: string example: 4001 statusMessage: type: string example: "Not allowed" SupportMessage: type: string example : "Method Not Allowed" transactionId : type: string example : af1ab6b4-9b1c-4397-bf92-5e1de673b944 408: type: object properties: statusCode: type: string example: 3003 statusMessage: type: string example: "Time out" SupportMessage: type: string example : "Request timed out" transactionId : type: string example : af1ab6b4-9b1c-4397-bf92-5e1de673b944 500: type: object properties: statusCode: type: string example: 3001 statusMessage: type: string example: "System Error" SupportMessage: type: string example : "System internal error occured" transactionId : type: string example : af1ab6b4-9b1c-4397-bf92-5e1de673b944 securitySchemes: OAuth_security_schema: type: oauth2 flows: clientCredentials: tokenUrl: https://api.chenosis.io/client/accesstoken?grant_type=client_credentials scopes: {}