{ "uuid": "ed080838-e3bf-4c00-8751-3e2c36b3847f", "lastMigration": 29, "name": "Verify API", "endpointPrefix": "verify", "latency": 0, "port": 3000, "hostname": "", "routes": [ { "uuid": "892ea17a-5ba1-4012-87b9-02fd733444da", "documentation": "Verify Check", "method": "post", "endpoint": "check/:format", "responses": [ { "uuid": "0e6b014f-aab8-4b2b-a57c-48557ebe140e", "body": "{\n \"currency\": \"EUR\",\n \"estimated_price_messages_sent\": \"0.03330000\",\n \"event_id\": \"0A00000012345678\",\n \"price\": \"0.10000000\",\n \"request_id\": \"abcdef0123456789abcdef0123456789\",\n \"status\": \"0\"\n}", "latency": 0, "statusCode": 200, "label": "OK", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "c939abf1-b2bb-4c09-9e77-a499c7159993", "documentation": "Verify Control", "method": "post", "endpoint": "control/:format", "responses": [ { "uuid": "ad3fa84e-4d81-4b83-832a-e43c79637645", "body": "{\n \"command\": \"{{oneOf (array 'cancel' 'trigger_next_event')}}\",\n \"status\": \"0\"\n}", "latency": 0, "statusCode": 200, "label": "OK", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "7db3ec3f-7486-4814-994a-8342c246b3cf", "documentation": "Request a network unblock", "method": "post", "endpoint": "network-unblock", "responses": [ { "uuid": "29791a3e-df99-4733-ae2f-b7c6605db645", "body": "{\n \"network\": \"23410\",\n \"unblocked_until\": \"2024-04-22T08:34:58Z\"\n}", "latency": 0, "statusCode": 202, "label": "Accepted", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "b71d64af-1e99-4f45-97d3-93ed0cd1cf2e", "body": "{\n \"detail\": \"Your account does not have permission to perform this action.\",\n \"instance\": \"bf0ca0bf927b3b52e3cb03217e1a1ddf\",\n \"title\": \"Forbidden\",\n \"type\": \"https://developer.vonage.com/api-errors#forbidden\"\n}", "latency": 0, "statusCode": 403, "label": "Forbidden", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "815577c4-8eab-4892-b6ff-0c0cf7858a32", "body": "{\n \"detail\": \"The network you provided does not have an active block.\",\n \"instance\": \"bf0ca0bf927b3b52e3cb03217e1a1ddf\",\n \"title\": \"Not Found\",\n \"type\": \"https://developer.vonage.com/api-errors#bad-request\"\n}", "latency": 0, "statusCode": 404, "label": "Not Found", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "8c6e730d-4ae1-405b-b656-333da61a0f5b", "body": "{\n \"detail\": \"Network is not in the request.\",\n \"instance\": \"bf0ca0bf927b3b52e3cb03217e1a1ddf\",\n \"invalid_parameters\": [\n {\n \"name\": \"network\",\n \"reason\": \"Network not found\"\n }\n ],\n \"title\": \"Network not found.\",\n \"type\": \"https://developer.vonage.com/api-errors#invalid-paramater\"\n}", "latency": 0, "statusCode": 422, "label": "Unprocessable Entity", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "1b03e887-bf70-4bee-97a7-de73b3345733", "body": "{\n \"detail\": \"Please wait, then retry your request\",\n \"instance\": \"bf0ca0bf927b3b52e3cb03217e1a1ddf\",\n \"title\": \"Rate Limit Hit\",\n \"type\": \"https://developer.vonage.com/api-errors/verify#rate-limit\"\n}", "latency": 0, "statusCode": 429, "label": "Rate Limited", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "626c65c4-7ce4-4a0a-a218-226f20646c37", "documentation": "PSD2 (Payment Services Directive 2) Request", "method": "post", "endpoint": "psd2/:format", "responses": [ { "uuid": "bdcb28d6-889b-4678-ba92-69fe403ea4b2", "body": "{\n \"request_id\": \"abcdef0123456789abcdef0123456789\",\n \"status\": \"0\"\n}", "latency": 0, "statusCode": 200, "label": "OK", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "f59a4e37-3ed1-40ca-8c34-e7890473e0dd", "documentation": "Verify Search", "method": "get", "endpoint": "search/:format", "responses": [ { "uuid": "781332fd-4775-47cc-a171-5bf161251222", "body": "{\n \"account_id\": \"abcdef01\",\n \"checks\": [\n {\n \"code\": \"987654\",\n \"date_received\": \"2020-01-01 12:00:00\",\n \"ip_address\": \"123.0.0.255\",\n \"status\": \"{{oneOf (array 'VALID' 'INVALID')}}\"\n }\n ],\n \"currency\": \"EUR\",\n \"date_finalized\": \"2020-01-01 12:00:00\",\n \"date_submitted\": \"2020-01-01 12:00:00\",\n \"estimated_price_messages_sent\": \"0.03330000\",\n \"events\": [\n {\n \"id\": \"\",\n \"type\": \"{{oneOf (array 'tts' 'sms')}}\"\n }\n ],\n \"first_event_date\": \"2020-01-01 12:00:00\",\n \"last_event_date\": \"2020-01-01 12:00:00\",\n \"number\": \"447700900000\",\n \"price\": \"0.10000000\",\n \"request_id\": \"abcdef0123456789abcdef0123456789\",\n \"sender_id\": \"mySenderId\",\n \"status\": \"{{oneOf (array 'IN PROGRESS' 'SUCCESS' 'FAILED' 'EXPIRED' 'CANCELLED')}}\"\n}", "latency": 0, "statusCode": 200, "label": "OK", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "9de337f0-fa74-4d98-b918-003eba763efe", "documentation": "Request a Verification", "method": "post", "endpoint": ":format", "responses": [ { "uuid": "a93f29e1-383a-4b90-aff6-abfba4801fa4", "body": "{\n \"request_id\": \"abcdef0123456789abcdef0123456789\",\n \"status\": \"0\"\n}", "latency": 0, "statusCode": 200, "label": "OK", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" } ], "proxyMode": false, "proxyHost": "", "proxyRemovePrefix": false, "tlsOptions": { "enabled": false, "type": "CERT", "pfxPath": "", "certPath": "", "keyPath": "", "caPath": "", "passphrase": "" }, "cors": true, "headers": [], "proxyReqHeaders": [{ "key": "", "value": "" }], "proxyResHeaders": [{ "key": "", "value": "" }], "data": [], "folders": [], "rootChildren": [ { "type": "route", "uuid": "892ea17a-5ba1-4012-87b9-02fd733444da" }, { "type": "route", "uuid": "c939abf1-b2bb-4c09-9e77-a499c7159993" }, { "type": "route", "uuid": "7db3ec3f-7486-4814-994a-8342c246b3cf" }, { "type": "route", "uuid": "626c65c4-7ce4-4a0a-a218-226f20646c37" }, { "type": "route", "uuid": "f59a4e37-3ed1-40ca-8c34-e7890473e0dd" }, { "type": "route", "uuid": "9de337f0-fa74-4d98-b918-003eba763efe" } ] }