{"openapi":"3.1.0","info":{"title":"Apizie","version":"2.0.0","description":"One API key, one envelope, many public data sources."},"servers":[{"url":"https://apizie.tech"}],"security":[{"ApiKeyAuth":[]}],"paths":{"/v1/open-data:nexmo-verify/verify-check":{"post":{"operationId":"open_data_nexmo_verify_verify_check","summary":"Verify Check","description":"POST /check/{format}","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["format","body"],"properties":{"format":{"type":"string","enum":["json","xml"],"description":"The response format."},"body":{"type":"object","description":"Form fields as a JSON object"}}}}}},"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"}},"/v1/open-data:nexmo-verify/verify-control":{"post":{"operationId":"open_data_nexmo_verify_verify_control","summary":"Verify Control","description":"POST /control/{format}","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["format","body"],"properties":{"format":{"type":"string","enum":["json","xml"],"description":"The response format."},"body":{"type":"object","description":"Form fields as a JSON object"}}}}}},"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"}},"/v1/open-data:nexmo-verify/network-unblock":{"post":{"operationId":"open_data_nexmo_verify_network_unblock","summary":"Request a network unblock","description":"POST /network-unblock","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"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"}},"/v1/open-data:nexmo-verify/verify-request-with-psd2":{"post":{"operationId":"open_data_nexmo_verify_verify_request_with_psd2","summary":"PSD2 (Payment Services Directive 2) Request","description":"POST /psd2/{format}","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["format","body"],"properties":{"format":{"type":"string","enum":["json","xml"],"description":"The response format."},"body":{"type":"object","description":"Form fields as a JSON object"}}}}}},"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"}},"/v1/open-data:nexmo-verify/verify-search":{"get":{"operationId":"open_data_nexmo_verify_verify_search","summary":"Verify Search","description":"GET /search/{format}","tags":["open-data"],"parameters":[{"name":"format","in":"query","required":true,"description":"The response format.","schema":{"type":"string","enum":["json","xml"],"description":"The response format."},"example":"json"},{"name":"api_key","in":"query","required":true,"description":"You can find your API key in your [account dashboard](https://dashboard.nexmo.com)","schema":{"type":"string","description":"You can find your API key in your [account dashboard](https://dashboard.nexmo.com)"}},{"name":"api_secret","in":"query","required":true,"description":"You can find your API secret in your [account dashboard](https://dashboard.nexmo.com)","schema":{"type":"string","description":"You can find your API secret in your [account dashboard](https://dashboard.nexmo.com)"}},{"name":"request_id","in":"query","required":true,"description":"The `request_id` you received in the Verify Request Response. Required if `request_ids` not provided.","schema":{"type":"string","description":"The `request_id` you received in the Verify Request Response. Required if `request_ids` not provided."},"example":"abcdef0123456789abcdef0123456789"},{"name":"request_ids","in":"query","required":false,"description":"More than one `request_id`. Each `request_id` is a new parameter in the Verify Search request. Required if `request_id` not provided.","schema":{"type":"array","description":"More than one `request_id`. Each `request_id` is a new parameter in the Verify Search request. Required if `request_id` not provided."}}],"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/open-data:nexmo-verify/verify-request":{"post":{"operationId":"open_data_nexmo_verify_verify_request","summary":"Request a Verification","description":"POST /{format}","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["format","body"],"properties":{"format":{"type":"string","enum":["json","xml"],"description":"The response format."},"body":{"type":"object","description":"Form fields as a JSON object"}}}}}},"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"}}}}}}}