{"openapi":"3.1.0","info":{"title":"Apizie","version":"2.0.0","description":"One API key, one envelope, many public data sources."},"servers":[{"url":"https://zieapi.vercel.app"}],"security":[{"ApiKeyAuth":[]}],"paths":{"/v1/communication:fraudlabspro-sms-verification/get-v1-verification-result":{"get":{"operationId":"communication_fraudlabspro_sms_verification_get_v1_verification_result","summary":"Verify that an OTP sent by the Send SMS Verification API is valid.","description":"GET /v1/verification/result","tags":["communication"],"parameters":[{"name":"tran_id","in":"query","required":true,"description":"The unique ID that was returned by the Send Verification SMS API that triggered the OTP sms.","schema":{"type":"string","description":"The unique ID that was returned by the Send Verification SMS API that triggered the OTP sms."}},{"name":"key","in":"query","required":true,"description":"FraudLabs Pro API key.","schema":{"type":"string","description":"FraudLabs Pro API key."}},{"name":"format","in":"query","required":false,"description":"Returns the API response in json (default) or xml format.","schema":{"type":"string","enum":["json","xml"],"description":"Returns the API response in json (default) or xml format."}},{"name":"otp","in":"query","required":true,"description":"The OTP that was sent to the recipient’s phone.","schema":{"type":"string","description":"The OTP that was sent to the recipient’s phone."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/communication:fraudlabspro-sms-verification/post-v1-verification-send":{"post":{"operationId":"communication_fraudlabspro_sms_verification_post_v1_verification_send","summary":"Send an SMS with verification code and a custom message for authentication purpose.","description":"POST /v1/verification/send","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["tel","key"],"properties":{"country_code":{"type":"string","description":"ISO 3166 country code for the recipient mobile phone number. If parameter is supplied, then some basic telephone number validation is done."},"format":{"type":"string","enum":["json","xml"],"description":"Returns the API response in json (default) or xml format."},"tel":{"type":"string","description":"The recipient mobile phone number in E164 format which is a plus followed by just numbers with no spaces or parentheses."},"key":{"type":"string","description":"FraudLabs Pro API key."},"mesg":{"type":"string","description":"The message template for the SMS. Add as placeholder for the actual OTP to be generated. Max length is 140 characters."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}}},"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"x-api-key"}},"schemas":{"RunEnvelope":{"type":"object","required":["project","data","timestamp"],"properties":{"project":{"type":"string","example":"dev-tools:hash"},"data":{},"timestamp":{"type":"string","format":"date-time"}}},"ErrorEnvelope":{"type":"object","properties":{"content":{},"message":{"type":"string"},"errors":{"type":"array","items":{}},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}}}}}},"responses":{"Error":{"description":"Invalid key, plan gate, rate limit or upstream failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}}}}