{ "info": { "_postman_id": "b9812e7c-921b-4a31-8044-f1b2aca63ca3", "name": "BriteVerify API Suite Documentation", "description": "## Authorization\n\nTo get started, you must first create your API key:\n\n1. Log in to your account and go to the [API Keys tab](https://app.briteverify.com/account/api_keys).\n2. Click on 'Generate New Key', and provide a key name. This name is for your convenience and has no bearing on your implementation.\n3. Select a key type. If using this API key in a client-side implementation, select *Client-side*, otherwise select *Server-side*.\n4. If *Client-side*, you have some additional options available. Learn more ↗\n5. Once your key is created, it will appear in your keys list and is activated for use.\n \n\n* * *\n\n## API Key Best Practices\n\nAPI keys are sensitive and give access to the data in your account and access to perform new verifications. **Only trusted sources should be given access to your API keys**.\n\nIf you suspect your key is compromised, it's best to go ahead and replace it—even if you can't yet prove it. You can easily de-activate it and replace it with a new one:\n\n1. Go to the [API Keys tab](https://app.briteverify.com/account/api_keys) in your BriteVerify account.\n2. Locate the key in question and click on the actions gear. Click 'disable'. **This action cannot be undone.**\n3. Generate a new key and replace the old one in your code.\n \n\n## Status Responses\n\nA full list of email, phone, and mailing address statuses is available in the help center.\n\n## Performance, Usage, & Rate Limits\n\n* * *\n\n| **Touchpoint** | **Rate Limits** | **Processing Speeds** | **Notes** |\n| --- | --- | --- | --- |\n| Real-time Single Transaction API (all versions) | **500**
Verifications per key, per minute. Applies to both server-side and client-side (public) keys.

**25**
Verifications per client IP address, per minute. Applies to client-side (public) keys only. This applies in addition to the 500 verifications per key, per minute limit. | **500** ms
Average response time


| If you believe your transactional traffic will be greater than 500 requests per key, per minute, please reach out to our support team. When being rate limited you will receive a `429` response, which you should develop around if you suspect you could approach these limits. |\n| Bulk API (all versions) | **100k**
Emails per page

**1M**
Email addresses per job (or 20 pages of 50k) | **4,000**
Average verifications per minute | This is an average based upon performance achieved by 95% of customers. Actual speeds can vary depending upon network load, time of day, domain response times, and quality of addresses being verified. |", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "_exporter_id": "26854672" }, "item": [ { "name": "Real-time Single Transaction APIs", "item": [ { "name": "v1", "item": [ { "name": "Account Information", "item": [ { "name": "Credits", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "body": { "mode": "raw", "raw": "" }, "url": { "raw": "{{v1_base_url}}/api/v1/accounts/credits", "host": [ "{{v1_base_url}}" ], "path": [ "api", "v1", "accounts", "credits" ] }, "description": "This endpoint will return your account credit balance and credits in reserve*, current as of the `recorded_on` timestamp.\n\n*Credits in reserve are those being held for currently processing list uploads (via manual upload or bulk api upload)" }, "response": [ { "name": "Credit Balance", "originalRequest": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "type": "text", "value": "ApiKey: {{api_key}}" } ], "url": { "raw": "{{base_url}}/api/v1/accounts/credits", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "accounts", "credits" ] } }, "_postman_previewlanguage": "json", "header": null, "cookie": [], "body": "{\n \"credits\": 2165,\n \"credits_in_reserve\": 500,\n \"recorded_on\": \"2021-07-27T21:10:10.000+0000\"\n}" } ] } ] }, { "name": "Email Only", "event": [ { "listen": "test", "script": { "exec": [ "" ], "type": "text/javascript" } } ], "request": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"email\": \"sales@validity.com\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{v1_base_url}}/api/public/v1/fullverify", "host": [ "{{v1_base_url}}" ], "path": [ "api", "public", "v1", "fullverify" ] }, "description": "**This example assumes use of** [public keys](https://help.returnpath.com/hc/en-us/articles/4407473214619-Public-Keys-for-the-Real-time-Single-Transaction-API)**. If not using, remove** **`/public/`** **from the path.**" }, "response": [ { "name": "Email Only", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "name": "Content-Type", "type": "text", "value": "application/json" }, { "key": "Authorization", "type": "text", "value": "ApiKey: {{api_key}}" } ], "body": { "mode": "raw", "raw": "{\n \"email\": \"sales@validity.com\"\n}" }, "url": { "raw": "{{base_url}}/api/public/v1/fullverify", "host": [ "{{base_url}}" ], "path": [ "api", "public", "v1", "fullverify" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Date", "value": "Thu, 14 May 2020 20:39:04 GMT" }, { "key": "Content-Type", "value": "application/json; charset=utf-8" }, { "key": "Transfer-Encoding", "value": "chunked" }, { "key": "Connection", "value": "keep-alive" }, { "key": "ETag", "value": "W/\"9732bc10c98db412fc6bba7b23772d4f\"" }, { "key": "Cache-Control", "value": "max-age=0, private, must-revalidate" }, { "key": "X-Request-Id", "value": "7993c226-dc05-4158-847f-3d12edf81876" }, { "key": "X-Runtime", "value": "0.046089" } ], "cookie": [], "body": "{\n \"email\": {\n \"address\": \"sales@validity.com\",\n \"account\": \"sales\",\n \"domain\": \"validity.com\",\n \"status\": \"valid\",\n \"connected\": null,\n \"disposable\": false,\n \"role_address\": true\n },\n \"duration\": 0.035602396\n}" }, { "name": "Email Only - accept_all + disposable", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "name": "Content-Type", "type": "text", "value": "application/json" }, { "key": "Authorization", "type": "text", "value": "ApiKey: {{api_key}}" } ], "body": { "mode": "raw", "raw": "{\n \"email\": \"fake@mailinator.com\"\n}" }, "url": { "raw": "{{base_url}}/api/public/v1/fullverify", "host": [ "{{base_url}}" ], "path": [ "api", "public", "v1", "fullverify" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Date", "value": "Thu, 14 May 2020 20:42:04 GMT" }, { "key": "Content-Type", "value": "application/json; charset=utf-8" }, { "key": "Transfer-Encoding", "value": "chunked" }, { "key": "Connection", "value": "keep-alive" }, { "key": "ETag", "value": "W/\"db7c12129df25e7e292f1ecc3911f361\"" }, { "key": "Cache-Control", "value": "max-age=0, private, must-revalidate" }, { "key": "X-Request-Id", "value": "4bfbba59-818f-414c-8649-160708cb0b32" }, { "key": "X-Runtime", "value": "0.093414" } ], "cookie": [], "body": "{\n \"email\": {\n \"address\": \"fake@mailinator.com\",\n \"account\": \"fake\",\n \"domain\": \"mailinator.com\",\n \"status\": \"accept_all\",\n \"connected\": null,\n \"disposable\": true,\n \"role_address\": false\n },\n \"duration\": 0.081746428\n}" }, { "name": "Email Only - Invalid", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "name": "Content-Type", "type": "text", "value": "application/json" }, { "key": "Authorization", "type": "text", "value": "ApiKey: {{api_key}}" } ], "body": { "mode": "raw", "raw": "{\"email\": \"invalidtest@validity.com\"}" }, "url": { "raw": "{{base_url}}/api/public/v1/fullverify", "host": [ "{{base_url}}" ], "path": [ "api", "public", "v1", "fullverify" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Date", "value": "Thu, 14 May 2020 20:39:51 GMT" }, { "key": "Content-Type", "value": "application/json; charset=utf-8" }, { "key": "Transfer-Encoding", "value": "chunked" }, { "key": "Connection", "value": "keep-alive" }, { "key": "ETag", "value": "W/\"3ce32afaf390786f56c385698553591e\"" }, { "key": "Cache-Control", "value": "max-age=0, private, must-revalidate" }, { "key": "X-Request-Id", "value": "a4eedb5e-ab11-4819-b80b-25a72b6a5d0a" }, { "key": "X-Runtime", "value": "0.302555" } ], "cookie": [], "body": "{\n \"email\": {\n \"address\": \"invalidtest@validity.com\",\n \"account\": \"invalidtest\",\n \"domain\": \"validity.com\",\n \"status\": \"invalid\",\n \"connected\": null,\n \"disposable\": false,\n \"role_address\": false,\n \"error_code\": \"email_account_invalid\",\n \"error\": \"Email account invalid\"\n },\n \"duration\": 0.291414519\n}" } ] }, { "name": "Phone Only", "event": [ { "listen": "test", "script": { "exec": [ "" ], "type": "text/javascript" } } ], "request": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"phone\": \"18009618205\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{v1_base_url}}/api/public/v1/fullverify", "host": [ "{{v1_base_url}}" ], "path": [ "api", "public", "v1", "fullverify" ] }, "description": "**This example assumes use of** [public keys](https://help.returnpath.com/hc/en-us/articles/4407473214619-Public-Keys-for-the-Real-time-Single-Transaction-API)**. If not using, remove** **`/public/`** **from the path.**\n\nPhone number verification available for the **United States** and **Canada** only at this time." }, "response": [ { "name": "Phone Only - Invalid", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "name": "Content-Type", "type": "text", "value": "application/json" }, { "key": "Authorization", "type": "text", "value": "ApiKey: {{api_key}}" } ], "body": { "mode": "raw", "raw": "{\n \"phone\": \"135315\"\n}" }, "url": { "raw": "{{base_url}}/api/public/v1/fullverify", "host": [ "{{base_url}}" ], "path": [ "api", "public", "v1", "fullverify" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Date", "value": "Thu, 14 May 2020 20:26:50 GMT" }, { "key": "Content-Type", "value": "application/json; charset=utf-8" }, { "key": "Transfer-Encoding", "value": "chunked" }, { "key": "Connection", "value": "keep-alive" }, { "key": "ETag", "value": "W/\"1d8204a32f8a38896ffa68096b5716eb\"" }, { "key": "Cache-Control", "value": "max-age=0, private, must-revalidate" }, { "key": "X-Request-Id", "value": "2917e94f-e863-45d0-ba2d-50f5f3506346" }, { "key": "X-Runtime", "value": "0.109584" } ], "cookie": [], "body": "{\n \"phone\": {\n \"number\": \"135315\",\n \"service_type\": null,\n \"phone_location\": null,\n \"status\": \"invalid\",\n \"errors\": [\n \"invalid_phone_number\"\n ]\n },\n \"duration\": 0.056220326\n}" }, { "name": "Phone only - Valid", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "name": "Content-Type", "type": "text", "value": "application/json" }, { "key": "Authorization", "type": "text", "value": "ApiKey: {{api_key}}" } ], "body": { "mode": "raw", "raw": "{\n \"phone\": \"18009618205\"\n}" }, "url": { "raw": "{{base_url}}/api/public/v1/fullverify", "host": [ "{{base_url}}" ], "path": [ "api", "public", "v1", "fullverify" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Date", "value": "Thu, 14 May 2020 20:50:04 GMT" }, { "key": "Content-Type", "value": "application/json; charset=utf-8" }, { "key": "Transfer-Encoding", "value": "chunked" }, { "key": "Connection", "value": "keep-alive" }, { "key": "ETag", "value": "W/\"a59f65e486a560b519ffd5abe2ac1e1c\"" }, { "key": "Cache-Control", "value": "max-age=0, private, must-revalidate" }, { "key": "X-Request-Id", "value": "df6c4b9a-5896-48c4-a564-322d9a8a59f0" }, { "key": "X-Runtime", "value": "0.044560" } ], "cookie": [], "body": "{\n \"phone\": {\n \"number\": \"18009618205\",\n \"service_type\": \"land\",\n \"phone_location\": null,\n \"status\": \"valid\",\n \"errors\": []\n },\n \"duration\": 0.032635276\n}" } ] }, { "name": "Address only", "event": [ { "listen": "test", "script": { "exec": [ "" ], "type": "text/javascript" } } ], "request": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"address\": {\n \t\"address1\": \"4010 W Boy Scout Blvd Ste 1100\",\n \t\"city\": \"Tampa\",\n \t\"state\": \"FL\",\n \t\"zip\": \"33607-5796\"\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{v1_base_url}}/api/public/v1/fullverify", "host": [ "{{v1_base_url}}" ], "path": [ "api", "public", "v1", "fullverify" ] }, "description": "**This example assumes use of** [public keys](https://help.returnpath.com/hc/en-us/articles/4407473214619-Public-Keys-for-the-Real-time-Single-Transaction-API)**. If not using, remove** **`/public/`** **from the path.**\n\nMailing address verification available for the **United States** and **Canada** only at this time." }, "response": [ { "name": "Invalid - Suite Missing", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "name": "Content-Type", "type": "text", "value": "application/json" }, { "key": "Authorization", "type": "text", "value": "ApiKey: {{api_key}}" } ], "body": { "mode": "raw", "raw": "{\n\t\"address\": {\n \t\"address1\": \"4010 Boy Scout Boulevard\",\n \t\"city\": \"Tampa\",\n \t\"state\": \"FL\",\n \t\"zip\": \"33607\"\n }\n}" }, "url": { "raw": "{{base_url}}/api/public/v1/fullverify", "host": [ "{{base_url}}" ], "path": [ "api", "public", "v1", "fullverify" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Date", "value": "Thu, 14 May 2020 20:56:16 GMT" }, { "key": "Content-Type", "value": "application/json; charset=utf-8" }, { "key": "Transfer-Encoding", "value": "chunked" }, { "key": "Connection", "value": "keep-alive" }, { "key": "ETag", "value": "W/\"c49b0ec63605910b3d4c92cd048b7c61\"" }, { "key": "Cache-Control", "value": "max-age=0, private, must-revalidate" }, { "key": "X-Request-Id", "value": "88db37ba-3d01-4904-bbde-c0690a243cf3" }, { "key": "X-Runtime", "value": "1.602903" } ], "cookie": [], "body": "{\n \"address\": {\n \"address1\": \"4010 W Boy Scout Blvd\",\n \"address2\": \" \",\n \"city\": \"Tampa\",\n \"state\": \"FL\",\n \"zip\": \"33607-5727\",\n \"status\": \"invalid\",\n \"errors\": [\n \"suite_missing\"\n ],\n \"corrected\": true\n },\n \"duration\": 1.589391364\n}" }, { "name": "Corrected Address - Invalid - Unknown Street", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "name": "Content-Type", "type": "text", "value": "application/json" }, { "key": "Authorization", "type": "text", "value": "ApiKey: {{api_key}}" } ], "body": { "mode": "raw", "raw": "{\n \"address\": {\n \t\"address1\": \"4010 Girl Scout Ave\",\n \t\"city\": \"Tampa\",\n \t\"state\": \"FL\",\n \t\"zip\": \"33607\"\n }\n}" }, "url": { "raw": "{{base_url}}/api/public/v1/fullverify", "host": [ "{{base_url}}" ], "path": [ "api", "public", "v1", "fullverify" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Date", "value": "Thu, 14 May 2020 20:45:27 GMT" }, { "key": "Content-Type", "value": "application/json; charset=utf-8" }, { "key": "Transfer-Encoding", "value": "chunked" }, { "key": "Connection", "value": "keep-alive" }, { "key": "ETag", "value": "W/\"9e0bb36ad678e752a4f82b030f4a008d\"" }, { "key": "Cache-Control", "value": "max-age=0, private, must-revalidate" }, { "key": "X-Request-Id", "value": "d30b79fb-7593-4c95-a4cd-21406fbf31ec" }, { "key": "X-Runtime", "value": "0.673185" } ], "cookie": [], "body": "{\n \"address\": {\n \"address1\": \"4010 Girl Scout Ave\",\n \"address2\": \" \",\n \"city\": \"Tampa\",\n \"state\": \"FL\",\n \"zip\": \"33607\",\n \"status\": \"invalid\",\n \"errors\": [\n \"unknown_street\"\n ],\n \"corrected\": false\n },\n \"duration\": 0.657597369\n}" }, { "name": "Address only - Valid", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "name": "Content-Type", "type": "text", "value": "application/json" }, { "key": "Authorization", "type": "text", "value": "ApiKey: {{api_key}}" } ], "body": { "mode": "raw", "raw": "{\n \"address\": {\n \t\"address1\": \"4010 W Boy Scout Blvd Ste 1100\",\n \t\"city\": \"Tampa\",\n \t\"state\": \"FL\",\n \t\"zip\": \"33607-5796\"\n }\n}" }, "url": { "raw": "{{base_url}}/api/public/v1/fullverify", "host": [ "{{base_url}}" ], "path": [ "api", "public", "v1", "fullverify" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Date", "value": "Thu, 14 May 2020 20:48:44 GMT" }, { "key": "Content-Type", "value": "application/json; charset=utf-8" }, { "key": "Transfer-Encoding", "value": "chunked" }, { "key": "Connection", "value": "keep-alive" }, { "key": "ETag", "value": "W/\"41153d90165039163b48ef27e899c0c7\"" }, { "key": "Cache-Control", "value": "max-age=0, private, must-revalidate" }, { "key": "X-Request-Id", "value": "f5588d7d-1444-421d-90e3-0155c0bb0771" }, { "key": "X-Runtime", "value": "0.120056" } ], "cookie": [], "body": "{\n \"address\": {\n \"address1\": \"4010 W Boy Scout Blvd Ste 1100\",\n \"address2\": \" \",\n \"city\": \"Tampa\",\n \"state\": \"FL\",\n \"zip\": \"33607-5796\",\n \"status\": \"valid\",\n \"errors\": [],\n \"corrected\": false\n },\n \"duration\": 0.108034192\n}" }, { "name": "Corrected Address", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "name": "Content-Type", "type": "text", "value": "application/json" }, { "key": "Authorization", "type": "text", "value": "ApiKey: {{api_key}}" } ], "body": { "mode": "raw", "raw": "{\n \"address\": {\n \t\"address1\": \"4010 Boy Scout Boulevard, Suite 1100\",\n \t\"city\": \"Tampa\",\n \t\"state\": \"FL\",\n \t\"zip\": \"33605\"\n }\n}" }, "url": { "raw": "{{base_url}}/api/public/v1/fullverify", "host": [ "{{base_url}}" ], "path": [ "api", "public", "v1", "fullverify" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Date", "value": "Thu, 14 May 2020 20:27:52 GMT" }, { "key": "Content-Type", "value": "application/json; charset=utf-8" }, { "key": "Transfer-Encoding", "value": "chunked" }, { "key": "Connection", "value": "keep-alive" }, { "key": "ETag", "value": "W/\"507e2c1b1ea3258fd5a04573cf146647\"" }, { "key": "Cache-Control", "value": "max-age=0, private, must-revalidate" }, { "key": "X-Request-Id", "value": "ed5d0484-65ee-4316-b72e-77909c993d0d" }, { "key": "X-Runtime", "value": "0.096155" } ], "cookie": [], "body": "{\n \"address\": {\n \"address1\": \"4010 W Boy Scout Blvd Ste 1100\",\n \"address2\": \" \",\n \"city\": \"Tampa\",\n \"state\": \"FL\",\n \"zip\": \"33607-5796\",\n \"status\": \"valid\",\n \"errors\": [],\n \"corrected\": true\n },\n \"duration\": 0.084670758\n}" } ] }, { "name": "Email, Phone, and Address", "event": [ { "listen": "test", "script": { "exec": [ "" ], "type": "text/javascript" } } ], "request": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"email\": \"sales@validity.com\",\n \"phone\": \"18009618205\",\n \"address\": {\n \t\"address1\": \"4010 Boy Scout Boulevard, Suite 1100\",\n \t\"city\": \"Tampa\",\n \t\"state\": \"FL\",\n \t\"zip\": \"33607\"\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{v1_base_url}}/api/public/v1/fullverify", "host": [ "{{v1_base_url}}" ], "path": [ "api", "public", "v1", "fullverify" ] }, "description": "**This example assumes use of** [public keys](https://help.returnpath.com/hc/en-us/articles/4407473214619-Public-Keys-for-the-Real-time-Single-Transaction-API)**. If not using, remove** **`/public/`** **from the path.**\n\nPhone number and mailing address verification available for the **United States** and **Canada** only at this time." }, "response": [ { "name": "Invalid email, valid phone, valid address", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "name": "Content-Type", "type": "text", "value": "application/json" }, { "key": "Authorization", "value": "ApiKey: {{api_key}}", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"email\": \"nmijvnuiwfmuirfnw@gwgwegew.com\",\n \"phone\": \"1-800-961-8205\",\n \"address\": {\n \t\"address1\": \"4010 Boy Scout Boulevard, Suite 1100\",\n \t\"city\": \"Tampa\",\n \t\"state\": \"FL\",\n \t\"zip\": \"33607\"\n }\n}" }, "url": { "raw": "{{base_url}}/api/public/v1/fullverify", "host": [ "{{base_url}}" ], "path": [ "api", "public", "v1", "fullverify" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Date", "value": "Thu, 14 May 2020 20:54:28 GMT" }, { "key": "Content-Type", "value": "application/json; charset=utf-8" }, { "key": "Transfer-Encoding", "value": "chunked" }, { "key": "Connection", "value": "keep-alive" }, { "key": "ETag", "value": "W/\"fc845afebc46399102d4f8dfb5c9f71d\"" }, { "key": "Cache-Control", "value": "max-age=0, private, must-revalidate" }, { "key": "X-Request-Id", "value": "0de8cf00-b8e8-41a1-a421-8110b7f24e0e" }, { "key": "X-Runtime", "value": "0.298313" } ], "cookie": [], "body": "{\n \"email\": {\n \"address\": \"nmijvnuiwfmuirfnw@gwgwegew.com\",\n \"account\": \"nmijvnuiwfmuirfnw\",\n \"domain\": \"gwgwegew.com\",\n \"status\": \"invalid\",\n \"connected\": null,\n \"disposable\": false,\n \"role_address\": false,\n \"error_code\": \"email_domain_invalid\",\n \"error\": \"Email domain invalid\"\n },\n \"phone\": {\n \"number\": \"18009618205\",\n \"service_type\": \"land\",\n \"phone_location\": null,\n \"status\": \"valid\",\n \"errors\": []\n },\n \"address\": {\n \"address1\": \"4010 W Boy Scout Blvd Ste 1100\",\n \"address2\": \" \",\n \"city\": \"Tampa\",\n \"state\": \"FL\",\n \"zip\": \"33607-5796\",\n \"status\": \"valid\",\n \"errors\": [],\n \"corrected\": true\n },\n \"duration\": 0.285692082\n}" }, { "name": "Valid Email, Valid Phone, and Valid Address", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "name": "Content-Type", "type": "text", "value": "application/json" }, { "key": "Authorization", "value": "ApiKey: {{api_key}}", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"email\": \"sales@validity.com\",\n \"phone\": \"18009618205\",\n \"address\": {\n \t\"address1\": \"4010 Boy Scout Boulevard, Suite 1100\",\n \t\"city\": \"Tampa\",\n \t\"state\": \"FL\",\n \t\"zip\": \"33607\"\n }\n}" }, "url": { "raw": "{{base_url}}/api/public/v1/fullverify", "host": [ "{{base_url}}" ], "path": [ "api", "public", "v1", "fullverify" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Date", "value": "Thu, 14 May 2020 20:00:27 GMT" }, { "key": "Content-Type", "value": "application/json; charset=utf-8" }, { "key": "Transfer-Encoding", "value": "chunked" }, { "key": "Connection", "value": "keep-alive" }, { "key": "ETag", "value": "W/\"4ff16a9e3e06a519c6ece4811dad5f18\"" }, { "key": "Cache-Control", "value": "max-age=0, private, must-revalidate" }, { "key": "X-Request-Id", "value": "994beec2-0cc4-40cb-afff-910ae8010ec2" }, { "key": "X-Runtime", "value": "2.399402" } ], "cookie": [], "body": "{\n \"email\": {\n \"address\": \"sales@validity.com\",\n \"account\": \"sales\",\n \"domain\": \"validity.com\",\n \"status\": \"valid\",\n \"connected\": null,\n \"disposable\": false,\n \"role_address\": true\n },\n \"phone\": {\n \"number\": \"18009618205\",\n \"service_type\": \"land\",\n \"phone_location\": null,\n \"status\": \"valid\",\n \"errors\": []\n },\n \"address\": {\n \"address1\": \"4010 W Boy Scout Blvd Ste 1100\",\n \"address2\": \" \",\n \"city\": \"Tampa\",\n \"state\": \"FL\",\n \"zip\": \"33607-5796\",\n \"status\": \"valid\",\n \"errors\": [],\n \"corrected\": true\n },\n \"duration\": 2.388141409\n}" } ] }, { "name": "Fields Missing Example", "event": [ { "listen": "test", "script": { "exec": [ "" ], "type": "text/javascript" } } ], "request": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"phone\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{v1_base_url}}/api/public/v1/fullverify", "host": [ "{{v1_base_url}}" ], "path": [ "api", "public", "v1", "fullverify" ] }, "description": "**This example assumes use of** [public keys](https://help.returnpath.com/hc/en-us/articles/4407473214619-Public-Keys-for-the-Real-time-Single-Transaction-API)**. If not using, remove** **`/public/`** **from the path.**" }, "response": [ { "name": "Invalid Phone", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "name": "Content-Type", "type": "text", "value": "application/json" }, { "key": "Authorization", "type": "text", "value": "ApiKey: {{api_key}}" } ], "body": { "mode": "raw", "raw": "{\n \"phone\": \"\"\n}" }, "url": { "raw": "{{base_url}}/api/public/v1/fullverify", "host": [ "{{base_url}}" ], "path": [ "api", "public", "v1", "fullverify" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Date", "value": "Thu, 14 May 2020 15:44:49 GMT" }, { "key": "Content-Type", "value": "application/json; charset=utf-8" }, { "key": "Transfer-Encoding", "value": "chunked" }, { "key": "Connection", "value": "keep-alive" }, { "key": "Cache-Control", "value": "no-cache" }, { "key": "X-Request-Id", "value": "95dfb64b-e4c7-4136-85c9-1f035d7b1381" }, { "key": "X-Runtime", "value": "0.041284" } ], "cookie": [], "body": "{\n \"errors\": {\n \"default\": \"invalid or missing query parameter\"\n }\n}" } ] }, { "name": "Invalid/Disabled API Key", "event": [ { "listen": "test", "script": { "exec": [ "" ], "type": "text/javascript" } } ], "request": { "auth": { "type": "apikey", "apikey": [ { "key": "value", "value": "ApiKey: got-em", "type": "string" }, { "key": "key", "value": "Authorization", "type": "string" } ] }, "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"phone\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{v1_base_url}}/api/public/v1/fullverify", "host": [ "{{v1_base_url}}" ], "path": [ "api", "public", "v1", "fullverify" ] }, "description": "**This example assumes use of** [public keys](https://help.returnpath.com/hc/en-us/articles/4407473214619-Public-Keys-for-the-Real-time-Single-Transaction-API)**. If not using, remove** **`/public/`** **from the path.**" }, "response": [ { "name": "Invalid/Disabled API Key", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "name": "Content-Type", "type": "text", "value": "application/json" }, { "key": "Authorization", "type": "text", "value": "ApiKey: {{api_key}}" } ], "body": { "mode": "raw", "raw": "{\n \"phone\": \"18009618205\"\n}" }, "url": { "raw": "{{base_url}}/api/public/v1/fullverify", "host": [ "{{base_url}}" ], "path": [ "api", "public", "v1", "fullverify" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Date", "value": "Thu, 14 May 2020 20:52:51 GMT" }, { "key": "Content-Type", "value": "application/json; charset=utf-8" }, { "key": "Transfer-Encoding", "value": "chunked" }, { "key": "Connection", "value": "keep-alive" }, { "key": "Cache-Control", "value": "no-cache" }, { "key": "X-Request-Id", "value": "e34f4e21-856a-409f-93bb-62f30d2b48f0" }, { "key": "X-Runtime", "value": "0.009849" } ], "cookie": [], "body": "{\n \"errors\": {\n \"user\": \"not authorized or over daily test limit for untrusted domains\"\n }\n}" } ] } ], "description": "The Real-Time Single Transaction API (v1) is a simple JSON-based REST Web Service that allows you to verify email addresses, phone numbers, and U.S. and Canadian mailing addresses on demand as a user enters them in a web form or mobile application.\n\n| **Secure Use**
|\n| --- |\n| All client-side implementations are **strongly encouraged** to use public keys with domain validation. Learn more ↗

|\n| **Note**: Neglecting to use [public keys](https://help.returnpath.com/hc/en-us/articles/4407473214619-Public-Keys-for-the-Real-time-Single-Transaction-API) exposes you to unnecessary risks that may result in loss of verification credits, which are not refundable. Validity does not take responsibility for loss that could have been prevented by using security features like Public Keys on a client-side implementation. |\n\n**Performance, Usage, & Rate Limits**\n\nThis API is intended for validating emails, phone numbers, and mailing addresses one-by-one. If you need to verify lists via API please see our Bulk API. [Learn More↗](https://docs.briteverify.com/#e673d752-0030-466c-9e7e-4f2fed63c848) \n\nSee above for more information on [Performance, Usage, & Rate Limits](https://docs.briteverify.com/#intro)\n\n**Status Responses**\n\nTo learn more about statuses returned, see Response Statuses & Errors ↗." } ] }, { "name": "Bulk Verification APIs", "item": [ { "name": "v3", "item": [ { "name": "Account Information", "item": [ { "name": "Credits", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "body": { "mode": "raw", "raw": "" }, "url": { "raw": "{{v3_base_url}}/api/v3/accounts/credits", "host": [ "{{v3_base_url}}" ], "path": [ "api", "v3", "accounts", "credits" ] }, "description": "This endpoint will return your account credit balance and credits in reserve*, current as of the `recorded_on` timestamp.\n\n*Credits in reserve are those being held for currently processing list uploads (via manual upload or bulk api upload)" }, "response": [ { "name": "Credit Balance", "originalRequest": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "type": "text", "value": "ApiKey: {{api_key}}" } ], "url": { "raw": "{{base_host}}/api/v3/accounts/credits", "host": [ "{{base_host}}" ], "path": [ "api", "v3", "accounts", "credits" ] } }, "_postman_previewlanguage": "json", "header": null, "cookie": [], "body": "{\n \"credits\": 2165,\n \"credits_in_reserve\": 500,\n \"recorded_on\": \"2021-07-27T21:10:10.000+0000\"\n}" } ] } ] }, { "name": "Lists", "item": [ { "name": "List", "request": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"directive\": \"start\",\n \"contacts\": [\n { \n \"phone\": \"4444444444\",\n \"email\": \"hello@example.com\"\n },\n { \n \"phone\": \"5555555555\",\n \"email\": \"goodbye@example.com\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{v3_base_url}}/api/v3/lists", "host": [ "{{v3_base_url}}" ], "path": [ "api", "v3", "lists" ] }, "description": "This method creates a new, empty list into which you can insert `emails` objects (containing an array of email addresses) or `contacts` objects (containing a max of one email address, one phone number, and one mailing address). \n\nIt will not start verifying until you pass the directive to start. \n\n
\n\n#### URL Parameters\n- - - - - - -\n**`external_id`** (optional)\n - This parameter is designed as a way to store an identifier with lists that you might process on behalf of your customers. This is ideal for agencies or resellers. Otherwise, leave this parameter out.\n\n*Example:*\n\n`POST /api/v3/accounts/:external_id/lists`\n`POST /api/v3/accounts/your-customer-ID/lists`\n\n\n**`list_id`** (optional)\n - When an open list is created, it remains in an open state until the directive to start is given. A list id will be returned in the response JSON, which can be used to continue appending to the list, queue the list for processing, or terminate the list.\n\n*Example:*\n\n`POST /api/v3/lists/:list_id`\n`POST /api/v3/lists/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX`\n\n*Example using `external_id`:*\n\n`POST /api/v3/accounts/:external_id/lists/:list_id`\n`POST /api/v3/accounts/your-customer-ID/lists/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX`\n\n
\n\n#### POST Body Top-level Parameters \n- - - - - - -\n\n**`directive`** (optional)\n - Available values: `start` or `terminate`\n - To immediately start a list for processing, pass the param `directive: start` with the `emails` param.\n - Passing `directive: start` at any point to an open list will queue the list for processing. \n - To create an open list that can be appended too, do not pass a `directive`. \n - To abandon an open list that's no longer needed, pass `directive: terminate`.\n\n\n**`contacts`** (**required**)\n - Must be an array of objects, each object containing up to one `email`, one `phone`, and one `address`. \n - Each object has a max of one email address, one phone number, and one address.\n - Max limit of 100,000 objects per POST, per page.\n\n\n**`contacts` Nested Parameters** (optional)\n- - - - - - -\n- `email`\n*Example:*\n```\n{\n \"contacts\": [\n {\n \"email\": \"hello@example.com\"\n }\n ]\n}\n```\n- `phone` (optional)\n*Example:*\n```\n{\n \"contacts\": [\n {\n \"phone\": \"4444444444\"\n }\n ]\n}\n```\n- `address` (optional)\n*Example:*\n```\n{\n \"contacts\": [\n {\n \"address\": {\n \"address1\": \"200 Clarendon St\",\n \"address2\": \"Unit 2200\",\n \"city\": \"Boston\",\n \"state\": \"MA\",\n \"zip\": \"02115\"\n }\n }\n ]\n}\n```" }, "response": [ { "name": "Create list", "originalRequest": { "method": "POST", "header": [ { "key": "Authorization", "value": "ApiKey: {{api_key}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"contacts\": [\n { \n \"email\": \"hello@example.com\",\n \"phone\": \"4444444444\",\n \"address\": {\n \"address1\": \"200 Clarendon St\",\n \"address2\": \"Unit 2200\",\n \"city\": \"Boston\",\n \"state\": \"MA\",\n \"zip\": \"02115\"\n }\n \n },\n { \n \"email\": \"hello@example.com\",\n \"phone\": \"4444444444\",\n \"address\": {\n \"address1\": \"200 Clarendon St\",\n \"address2\": \"Unit 2200\",\n \"city\": \"Boston\",\n \"state\": \"MA\",\n \"zip\": \"02115\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base_host}}/api/v3/lists", "host": [ "{{base_host}}" ], "path": [ "api", "v3", "lists" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Date", "value": "Wed, 27 May 2020 01:45:35 GMT" }, { "key": "Connection", "value": "close" }, { "key": "Content-Type", "value": "application/json; charset=utf-8" }, { "key": "ETag", "value": "W/\"8f65a70267ae90b50b94fc0751b49921\"" }, { "key": "Cache-Control", "value": "max-age=0, private, must-revalidate" }, { "key": "Set-Cookie", "value": "_bvapp_session=b09OZTQrRElBcVJSMkxjVEJYaFhhamtBWUh1UzVtUGFzL0R3akYreUNPQlBJYjFMN0VlNjJDSGRQbUhvVU9wc3NaWkIyTzZUdzN2R1M0YUQ0RUtkYW92WVhXajBtOVlBY3RCM2dMck1mbzhsbWs1bllyNEpxeUx2VWFtRVB1NXhVVEdNOFExeDJjY0RsUjZ3enphTElnPT0tLWl0c3RSaFlZUTZjeS9Pa2JuOUZDSFE9PQ%3D%3D--8cfd3c8a47a613f10767f49a745ed5e5af9bae53; path=/; HttpOnly; SameSite=Lax" }, { "key": "X-Request-Id", "value": "45fd9ef0-18eb-464b-9717-f1a94619b087" }, { "key": "X-Frame-Options", "value": "DENY" }, { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "X-XSS-Protection", "value": "1; mode=block" }, { "key": "X-Download-Options", "value": "noopen" }, { "key": "X-Permitted-Cross-Domain-Policies", "value": "none" }, { "key": "Referrer-Policy", "value": "strict-origin-when-cross-origin" }, { "key": "Transfer-Encoding", "value": "chunked" } ], "cookie": [], "body": "{\n \"status\": \"success\",\n \"message\": \"created new list\",\n \"list\": {\n \"id\": \"XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX\",\n \"state\": \"open\",\n \"total_verified\": 0,\n \"total_verified_emails\": 0,\n \"total_verified_phones\": 0,\n \"page_count\": 0,\n \"progress\": 0,\n \"created_at\": \"08-10-2021 04:03 pm\",\n \"expiration_date\": null,\n \"results_path\": null\n }\n}" }, { "name": "Append to list", "originalRequest": { "method": "POST", "header": [ { "key": "Authorization", "value": "ApiKey: {{api_key}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"contacts\": [\n { \n \"email\": \"hello@example.com\",\n \"phone\": \"4444444444\",\n \"address\": {\n \"address1\": \"200 Clarendon St\",\n \"address2\": \"Unit 2200\",\n \"city\": \"Boston\",\n \"state\": \"MA\",\n \"zip\": \"02115\"\n }\n \n },\n { \n \"email\": \"hello@example.com\",\n \"phone\": \"4444444444\",\n \"address\": {\n \"address1\": \"200 Clarendon St\",\n \"address2\": \"Unit 2200\",\n \"city\": \"Boston\",\n \"state\": \"MA\",\n \"zip\": \"02115\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base_host}}/api/v2/lists/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "host": [ "{{base_host}}" ], "path": [ "api", "v2", "lists", "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Date", "value": "Thu, 28 May 2020 15:59:00 GMT" }, { "key": "Connection", "value": "close" }, { "key": "Content-Type", "value": "application/json; charset=utf-8" }, { "key": "ETag", "value": "W/\"310f9701c6b5693e93cf433bcec45d4d\"" }, { "key": "Cache-Control", "value": "max-age=0, private, must-revalidate" }, { "key": "Set-Cookie", "value": "_bvapp_session=bURYQ1dVM3hCU0VaWGF4cTRBcHJyZnFmTUVZdGZLVEc5VFRzbGxxT2JLRVk3ampzMWtLcWwrMVVlSlJpdExqK21FTm56NVZ0NHFmYktQVFNkN3FjbFZIc09WbFBRcnFTSjhwK1hVQjBSSjd6VUpBS3NDTGVQZi8rV2pZcmxFc3RRU250aW5uWGZySWh5SEVkMEtQSXRBPT0tLS9zUlhzR1pjdEFrSFYydVA2enZVdVE9PQ%3D%3D--325fc230d3fceacf3fdc854246a470af2c6cc055; path=/; HttpOnly; SameSite=Lax" }, { "key": "X-Request-Id", "value": "16a50f27-60df-4def-826b-edae2ffb4b2e" }, { "key": "X-Frame-Options", "value": "DENY" }, { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "X-XSS-Protection", "value": "1; mode=block" }, { "key": "X-Download-Options", "value": "noopen" }, { "key": "X-Permitted-Cross-Domain-Policies", "value": "none" }, { "key": "Referrer-Policy", "value": "strict-origin-when-cross-origin" }, { "key": "Transfer-Encoding", "value": "chunked" } ], "cookie": [], "body": "{\n \"status\": \"success\",\n \"message\": \"updated existing list\",\n \"list\": {\n \"id\": \"XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX\",\n \"state\": \"open\",\n \"total_verified\": 0,\n \"total_verified_emails\": 0,\n \"total_verified_phones\": 0,\n \"page_count\": 0,\n \"progress\": 0,\n \"created_at\": \"08-10-2021 04:03 pm\",\n \"expiration_date\": null,\n \"results_path\": null\n }\n}" }, { "name": "Verify list", "originalRequest": { "method": "POST", "header": [ { "key": "Authorization", "type": "text", "value": "ApiKey: {{api_key}}" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"directive\": \"start\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base_host}}/api/v3/lists/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "host": [ "{{base_host}}" ], "path": [ "api", "v3", "lists", "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX" ] } }, "_postman_previewlanguage": "json", "header": null, "cookie": [], "body": "{\n \"status\": \"success\",\n \"message\": \"terminated list\",\n \"list\": {\n \"id\": \"XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX\",\n \"state\": \"terminated\",\n \"total_verified\": 0,\n \"total_verified_emails\": 0,\n \"total_verified_phones\": 0,\n \"page_count\": 0,\n \"progress\": 0,\n \"created_at\": \"08-10-2021 04:03 pm\",\n \"expiration_date\": null,\n \"results_path\": null,\n \"errors\": [\n {\n \"code\": \"import_error\",\n \"message\": \"user terminated at 08-10-2021 04:07PM\"\n }\n ]\n }\n}" }, { "name": "Create + verify list", "originalRequest": { "method": "POST", "header": [ { "key": "Authorization", "value": "ApiKey: {{api_key}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"directive\": \"start\",\n \"contacts\": [\n { \n \"email\": \"hello@example.com\",\n \"phone\": \"4444444444\",\n \"address\": {\n \"address1\": \"200 Clarendon St\",\n \"address2\": \"Unit 2200\",\n \"city\": \"Boston\",\n \"state\": \"MA\",\n \"zip\": \"02115\"\n }\n \n },\n { \n \"email\": \"hello@example.com\",\n \"phone\": \"4444444444\",\n \"address\": {\n \"address1\": \"200 Clarendon St\",\n \"address2\": \"Unit 2200\",\n \"city\": \"Boston\",\n \"state\": \"MA\",\n \"zip\": \"02115\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base_host}}/api/v3/lists", "host": [ "{{base_host}}" ], "path": [ "api", "v3", "lists" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Date", "value": "Wed, 27 May 2020 15:16:41 GMT" }, { "key": "Connection", "value": "close" }, { "key": "Content-Type", "value": "application/json; charset=utf-8" }, { "key": "ETag", "value": "W/\"6be1cf2e7f7368fc3d65503dd26c30f1\"" }, { "key": "Cache-Control", "value": "max-age=0, private, must-revalidate" }, { "key": "Set-Cookie", "value": "_bvapp_session=bHVwejF2ektXWjdrbXFSVXVQK01aTE1CdUdvL2Jya0JHeURFYmVTQXRvaXcrcEhGTUY3WkhpZmJHTldBRENpVE0yWG03cEM1cEZNTXNXWU55b1Y4RnNTam1MQ09YdkhJN0FPRWdYN2VOK3laVkQvSU50bG9sUFRjQXoyMTRoNG9ZTXVRVlhFWWsvYkh5c2Y4N1AwM3FnPT0tLVRiamtKQlU1NGZja0k4bm5MUURKelE9PQ%3D%3D--e9a946520f5f9677d0bd21672369b9f740a2ed60; path=/; HttpOnly; SameSite=Lax" }, { "key": "X-Request-Id", "value": "ec9c554f-521f-4460-89d4-4184a6b4ce56" }, { "key": "X-Frame-Options", "value": "DENY" }, { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "X-XSS-Protection", "value": "1; mode=block" }, { "key": "X-Download-Options", "value": "noopen" }, { "key": "X-Permitted-Cross-Domain-Policies", "value": "none" }, { "key": "Referrer-Policy", "value": "strict-origin-when-cross-origin" }, { "key": "Transfer-Encoding", "value": "chunked" } ], "cookie": [], "body": "{\n \"status\": \"success\",\n \"message\": \"list queued for processing\",\n \"list\": {\n \"id\": \"XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX\",\n \"state\": \"pending\",\n \"total_verified\": 0,\n \"total_verified_emails\": 0,\n \"total_verified_phones\": 0,\n \"page_count\": 0,\n \"progress\": 0,\n \"created_at\": \"08-10-2021 03:58 pm\",\n \"expiration_date\": null,\n \"results_path\": null\n }\n}" }, { "name": "Terminate list", "originalRequest": { "method": "POST", "header": [ { "key": "Authorization", "type": "text", "value": "ApiKey: {{api_key}}" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"directive\": \"terminate\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base_host}}/api/v3/lists/1234-1234-1234", "host": [ "{{base_host}}" ], "path": [ "api", "v3", "lists", "1234-1234-1234" ] } }, "_postman_previewlanguage": "json", "header": null, "cookie": [], "body": "{\n \"status\": \"success\",\n \"message\": \"terminated list\",\n \"list\": {\n \"id\": \"XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX\",\n \"state\": \"terminated\",\n \"total_verified\": 0,\n \"total_verified_emails\": 0,\n \"total_verified_phones\": 0,\n \"page_count\": 0,\n \"progress\": 0,\n \"created_at\": \"08-10-2021 04:03 pm\",\n \"expiration_date\": null,\n \"results_path\": null,\n \"errors\": [\n {\n \"code\": \"import_error\",\n \"message\": \"user terminated at 08-10-2021 04:07PM\"\n }\n ]\n }\n}" }, { "name": "Create list (using External ID)", "originalRequest": { "method": "POST", "header": [ { "key": "Authorization", "value": "ApiKey: {{api_key}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"contacts\": [\n { \n \"email\": \"hello@example.com\",\n \"phone\": \"4444444444\",\n \"address\": {\n \"address1\": \"200 Clarendon St\",\n \"address2\": \"Unit 2200\",\n \"city\": \"Boston\",\n \"state\": \"MA\",\n \"zip\": \"02115\"\n }\n \n },\n { \n \"email\": \"hello@example.com\",\n \"phone\": \"4444444444\",\n \"address\": {\n \"address1\": \"200 Clarendon St\",\n \"address2\": \"Unit 2200\",\n \"city\": \"Boston\",\n \"state\": \"MA\",\n \"zip\": \"02115\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base_host}}/api/v3/accounts/:external_id/lists", "host": [ "{{base_host}}" ], "path": [ "api", "v3", "accounts", ":external_id", "lists" ], "variable": [ { "key": "external_id", "value": null } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Date", "value": "Wed, 27 May 2020 01:47:19 GMT" }, { "key": "Connection", "value": "close" }, { "key": "Content-Type", "value": "application/json; charset=utf-8" }, { "key": "ETag", "value": "W/\"c8da8ca75e031f94b39c044ae7375ab9\"" }, { "key": "Cache-Control", "value": "max-age=0, private, must-revalidate" }, { "key": "Set-Cookie", "value": "_bvapp_session=Y0lVdGtrTWs5WDU2Tk8xYVRoNjVYWDBBdzZ6ZVh3d1puM1V5YmFxcE5GU2ZBbFRUdEtqQmNyc2NvSjN4MVd6RlFaRnhZMmRFVXhLamJNS1VJY3Fnb0hVeUMwdXBFUFhpdjFRcWNWdEp0NEltMUU0Uy92a0EySmF6MDhqeDZFYkQ0Z09RS1p5YkxuRFhHdENROWVZa01RPT0tLVRJdzlUTnFpVHZpeEJPdGlmb0tKM2c9PQ%3D%3D--4e31d0be3aadf58252475670f5ba6ef862fb9e00; path=/; HttpOnly; SameSite=Lax" }, { "key": "X-Request-Id", "value": "87603158-86a6-4eb8-88a0-e9066313ca7d" }, { "key": "X-Frame-Options", "value": "DENY" }, { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "X-XSS-Protection", "value": "1; mode=block" }, { "key": "X-Download-Options", "value": "noopen" }, { "key": "X-Permitted-Cross-Domain-Policies", "value": "none" }, { "key": "Referrer-Policy", "value": "strict-origin-when-cross-origin" }, { "key": "Transfer-Encoding", "value": "chunked" } ], "cookie": [], "body": "{\n \"status\": \"success\",\n \"message\": \"created new list\",\n \"list\": {\n \"id\": \"XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX\",\n \"state\": \"open\",\n \"total_verified\": 0,\n \"total_verified_emails\": 0,\n \"total_verified_phones\": 0,\n \"page_count\": 0,\n \"progress\": 0,\n \"created_at\": \"08-10-2021 04:23 pm\",\n \"expiration_date\": null,\n \"results_path\": null,\n \"account_external_id\": \"12345\"\n }\n}" }, { "name": "Create + verify list (using External ID)", "originalRequest": { "method": "POST", "header": [ { "key": "Authorization", "type": "text", "value": "ApiKey: {{api_key}}" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"directive\":\"start\",\n \"contacts\": [\n { \n \"email\": \"hello@example.com\",\n \"phone\": \"4444444444\",\n \"address\": {\n \"address1\": \"200 Clarendon St\",\n \"address2\": \"Unit 2200\",\n \"city\": \"Boston\",\n \"state\": \"MA\",\n \"zip\": \"02115\"\n }\n \n },\n { \n \"email\": \"hello@example.com\",\n \"phone\": \"4444444444\",\n \"address\": {\n \"address1\": \"200 Clarendon St\",\n \"address2\": \"Unit 2200\",\n \"city\": \"Boston\",\n \"state\": \"MA\",\n \"zip\": \"02115\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base_host}}/api/v3/accounts/:external_id/lists/1234-1234-1234", "host": [ "{{base_host}}" ], "path": [ "api", "v3", "accounts", ":external_id", "lists", "1234-1234-1234" ], "variable": [ { "key": "external_id", "value": null } ] } }, "_postman_previewlanguage": "json", "header": null, "cookie": [], "body": "{\n \"status\": \"success\",\n \"message\": \"list queued for processing\",\n \"list\": {\n \"id\": \"XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX\",\n \"state\": \"pending\",\n \"total_verified\": 0,\n \"total_verified_emails\": 0,\n \"total_verified_phones\": 0,\n \"page_count\": 0,\n \"progress\": 0,\n \"created_at\": \"08-10-2021 04:25 pm\",\n \"expiration_date\": null,\n \"results_path\": null,\n \"account_external_id\": \"12345\"\n }\n}" }, { "name": "Error - Missing parameter", "originalRequest": { "method": "POST", "header": [ { "key": "Authorization", "value": "ApiKey: {{api_key}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"contacts\": [\n {}\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base_host}}/api/v3/lists", "host": [ "{{base_host}}" ], "path": [ "api", "v3", "lists" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Date", "value": "Wed, 27 May 2020 17:23:34 GMT" }, { "key": "Connection", "value": "close" }, { "key": "Content-Type", "value": "application/json; charset=utf-8" }, { "key": "Cache-Control", "value": "no-cache" }, { "key": "Set-Cookie", "value": "_bvapp_session=T21kMHdUb1BweGVwcVJ6eFE5VUhHVGRuYjFqakV0RFV4Z1FQNDBFVFNOUVZzR3BiTmwwWEg2a0hGSGhNcWgyZlg4ZTJEeC9GM2RLd1FVNG16bm5mejhmQnEvMW5UWFBVZjhHcVMwOVRxQWdyT1N2ZlVLQ0FnU2c1eVl5Z09VYWpPSmRKRW9EV2Y5T1dDRG5BblRSYUdBPT0tLXVJNzVyRjhDcG9rUy9hZGZTYnFFUGc9PQ%3D%3D--a99814b794998b4a09bf5d29be1068d9f1cb57a4; path=/; HttpOnly; SameSite=Lax" }, { "key": "X-Request-Id", "value": "abc26fe2-ea27-43f2-b76e-8acd41349968" }, { "key": "X-Frame-Options", "value": "DENY" }, { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "X-XSS-Protection", "value": "1; mode=block" }, { "key": "X-Download-Options", "value": "noopen" }, { "key": "X-Permitted-Cross-Domain-Policies", "value": "none" }, { "key": "Referrer-Policy", "value": "strict-origin-when-cross-origin" }, { "key": "Transfer-Encoding", "value": "chunked" } ], "cookie": [], "body": "{\n \"status\": \"missing_data\",\n \"message\": \"Request has missing or invalid emails or contacts array.\"\n}" }, { "name": "Error - Invalid parameter", "originalRequest": { "method": "POST", "header": [ { "key": "Authorization", "value": "ApiKey: {{api_key}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"emails\": [\n \"john.doe@email.com\",\n \"jane.doe@email.com\"\n ],\n \"contacts\": [\n { \n \"phone\": \"5555555555\",\n \"email\": \"example@mail.com\"\n },\n { \n \"phone\": \"6666666666\",\n \"email\": \"another-example@mail.com\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base_host}}/api/v3/lists", "host": [ "{{base_host}}" ], "path": [ "api", "v3", "lists" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Date", "value": "Wed, 27 May 2020 17:23:34 GMT" }, { "key": "Connection", "value": "close" }, { "key": "Content-Type", "value": "application/json; charset=utf-8" }, { "key": "Cache-Control", "value": "no-cache" }, { "key": "Set-Cookie", "value": "_bvapp_session=T21kMHdUb1BweGVwcVJ6eFE5VUhHVGRuYjFqakV0RFV4Z1FQNDBFVFNOUVZzR3BiTmwwWEg2a0hGSGhNcWgyZlg4ZTJEeC9GM2RLd1FVNG16bm5mejhmQnEvMW5UWFBVZjhHcVMwOVRxQWdyT1N2ZlVLQ0FnU2c1eVl5Z09VYWpPSmRKRW9EV2Y5T1dDRG5BblRSYUdBPT0tLXVJNzVyRjhDcG9rUy9hZGZTYnFFUGc9PQ%3D%3D--a99814b794998b4a09bf5d29be1068d9f1cb57a4; path=/; HttpOnly; SameSite=Lax" }, { "key": "X-Request-Id", "value": "abc26fe2-ea27-43f2-b76e-8acd41349968" }, { "key": "X-Frame-Options", "value": "DENY" }, { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "X-XSS-Protection", "value": "1; mode=block" }, { "key": "X-Download-Options", "value": "noopen" }, { "key": "X-Permitted-Cross-Domain-Policies", "value": "none" }, { "key": "Referrer-Policy", "value": "strict-origin-when-cross-origin" }, { "key": "Transfer-Encoding", "value": "chunked" } ], "cookie": [], "body": "{\n \"status\": \"duplicate_data\",\n \"message\": \"Request has both emails and contacts params\"\n}" }, { "name": "Error - Invalid/missing emails parameter", "originalRequest": { "method": "POST", "header": [ { "key": "Authorization", "value": "ApiKey: {{api_key}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"emails\": [\n {}\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base_host}}/api/v3/lists", "host": [ "{{base_host}}" ], "path": [ "api", "v3", "lists" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Date", "value": "Wed, 27 May 2020 17:23:34 GMT" }, { "key": "Connection", "value": "close" }, { "key": "Content-Type", "value": "application/json; charset=utf-8" }, { "key": "Cache-Control", "value": "no-cache" }, { "key": "Set-Cookie", "value": "_bvapp_session=T21kMHdUb1BweGVwcVJ6eFE5VUhHVGRuYjFqakV0RFV4Z1FQNDBFVFNOUVZzR3BiTmwwWEg2a0hGSGhNcWgyZlg4ZTJEeC9GM2RLd1FVNG16bm5mejhmQnEvMW5UWFBVZjhHcVMwOVRxQWdyT1N2ZlVLQ0FnU2c1eVl5Z09VYWpPSmRKRW9EV2Y5T1dDRG5BblRSYUdBPT0tLXVJNzVyRjhDcG9rUy9hZGZTYnFFUGc9PQ%3D%3D--a99814b794998b4a09bf5d29be1068d9f1cb57a4; path=/; HttpOnly; SameSite=Lax" }, { "key": "X-Request-Id", "value": "abc26fe2-ea27-43f2-b76e-8acd41349968" }, { "key": "X-Frame-Options", "value": "DENY" }, { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "X-XSS-Protection", "value": "1; mode=block" }, { "key": "X-Download-Options", "value": "noopen" }, { "key": "X-Permitted-Cross-Domain-Policies", "value": "none" }, { "key": "Referrer-Policy", "value": "strict-origin-when-cross-origin" }, { "key": "Transfer-Encoding", "value": "chunked" } ], "cookie": [], "body": "{\n \"status\": \"missing_data\",\n \"message\": \"Request has empty emails array\"\n}" }, { "name": "Error - Invalid/missing contacts parameter", "originalRequest": { "method": "POST", "header": [ { "key": "Authorization", "value": "ApiKey: {{api_key}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"emails\": [\n {}\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base_host}}/api/v3/lists", "host": [ "{{base_host}}" ], "path": [ "api", "v3", "lists" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Date", "value": "Wed, 27 May 2020 17:23:34 GMT" }, { "key": "Connection", "value": "close" }, { "key": "Content-Type", "value": "application/json; charset=utf-8" }, { "key": "Cache-Control", "value": "no-cache" }, { "key": "Set-Cookie", "value": "_bvapp_session=T21kMHdUb1BweGVwcVJ6eFE5VUhHVGRuYjFqakV0RFV4Z1FQNDBFVFNOUVZzR3BiTmwwWEg2a0hGSGhNcWgyZlg4ZTJEeC9GM2RLd1FVNG16bm5mejhmQnEvMW5UWFBVZjhHcVMwOVRxQWdyT1N2ZlVLQ0FnU2c1eVl5Z09VYWpPSmRKRW9EV2Y5T1dDRG5BblRSYUdBPT0tLXVJNzVyRjhDcG9rUy9hZGZTYnFFUGc9PQ%3D%3D--a99814b794998b4a09bf5d29be1068d9f1cb57a4; path=/; HttpOnly; SameSite=Lax" }, { "key": "X-Request-Id", "value": "abc26fe2-ea27-43f2-b76e-8acd41349968" }, { "key": "X-Frame-Options", "value": "DENY" }, { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "X-XSS-Protection", "value": "1; mode=block" }, { "key": "X-Download-Options", "value": "noopen" }, { "key": "X-Permitted-Cross-Domain-Policies", "value": "none" }, { "key": "Referrer-Policy", "value": "strict-origin-when-cross-origin" }, { "key": "Transfer-Encoding", "value": "chunked" } ], "cookie": [], "body": "{\n \"status\": \"missing_data\",\n \"message\": \"Request has empty emails array\"\n}" }, { "name": "Error - Invalid directive", "originalRequest": { "method": "POST", "header": [ { "key": "Authorization", "type": "text", "value": "ApiKey: {{api_key}}" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"directive\": \"begin\",\n \"contacts\": [\n { \n \"phone\": \"4444444444\",\n \"email\": \"hello@example.com\",\n \"address\": {\n \"address1\": \"200 Clarendon St\",\n \"address2\": \"Unit 2200\",\n \"city\": \"Boston\",\n \"state\": \"MA\",\n \"zip\": \"02115\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base_host}}/api/v3/lists", "host": [ "{{base_host}}" ], "path": [ "api", "v3", "lists" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": null, "cookie": [], "body": "{\n \"status\": \"invalid_state\",\n \"message\": \"Directive must be one of `terminate` or `start`\"\n}" }, { "name": "Error - Append to list - List not found", "originalRequest": { "method": "POST", "header": [ { "key": "Authorization", "value": "ApiKey: {{api_key}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"contacts\": [\n { \n \"phone\": \"4444444444\",\n \"email\": \"hello@example.com\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base_host}}/api/v3/lists/1234-1234-1233", "host": [ "{{base_host}}" ], "path": [ "api", "v3", "lists", "1234-1234-1233" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Date", "value": "Wed, 27 May 2020 15:22:57 GMT" }, { "key": "Connection", "value": "close" }, { "key": "Content-Type", "value": "application/json; charset=utf-8" }, { "key": "ETag", "value": "W/\"1d038a3c8c45673c9cf63f4cc33f7d28\"" }, { "key": "Cache-Control", "value": "max-age=0, private, must-revalidate" }, { "key": "Set-Cookie", "value": "_bvapp_session=ekV0NDBQQ1p4K296RGpQQlFjcVRka1AzK28wUytwQlhJMFMzOVlueWUwa2J4VFQrUGJhcndvSW9lNU5SWFJqZGtJbENPQlVjNUhFZWZKZkxtOWMwSXl5QThHZXdFMm02V3BWTGYxemtoZXhMNmY1NklsNnhxdmgyS3NNa084dzF5NXBaNjQxY2IzRkpyUGVEcExieEJ3PT0tLW1sZDBCU1FocEtOYlJzZkY1Qll2eGc9PQ%3D%3D--171b241f04ab78867afa7f459db81ffd23c8f1f8; path=/; HttpOnly; SameSite=Lax" }, { "key": "X-Request-Id", "value": "f7459735-59db-489c-a5bc-ba2be614cde6" }, { "key": "X-Frame-Options", "value": "DENY" }, { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "X-XSS-Protection", "value": "1; mode=block" }, { "key": "X-Download-Options", "value": "noopen" }, { "key": "X-Permitted-Cross-Domain-Policies", "value": "none" }, { "key": "Referrer-Policy", "value": "strict-origin-when-cross-origin" }, { "key": "Transfer-Encoding", "value": "chunked" } ], "cookie": [], "body": "{\n \"status\": \"not_found\",\n \"message\": \"No matching list found.\"\n}" }, { "name": "Error - Existing list - Invalid list state", "originalRequest": { "method": "POST", "header": [ { "key": "Authorization", "type": "text", "value": "ApiKey: {{api_key}}" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base_host}}/api/v3/lists/1234-1234-1234", "host": [ "{{base_host}}" ], "path": [ "api", "v3", "lists", "1234-1234-1234" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": null, "cookie": [], "body": "{\n \"status\": \"invalid_state\",\n \"message\": \"The provided job is in an invalid state--state is 'pending' and needs to be 'open' to continue\"\n}" }, { "name": "Error - Exceed max limit for objects", "originalRequest": { "method": "POST", "header": [ { "key": "Authorization", "value": "ApiKey: {{api_key}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"contacts\": [\n { \n \"phone\": \"4444444444\",\n \"email\": \"hello@example.com\"\n },\n ...\n { \n \"phone\": \"5555555555\",\n \"email\": \"jane.doe@example.com\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base_host}}/api/v3/lists", "host": [ "{{base_host}}" ], "path": [ "api", "v3", "lists" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Date", "value": "Wed, 27 May 2020 17:22:05 GMT" }, { "key": "Connection", "value": "close" }, { "key": "Content-Type", "value": "application/json; charset=utf-8" }, { "key": "Cache-Control", "value": "no-cache" }, { "key": "Set-Cookie", "value": "_bvapp_session=bytKMUpoVWpTb2VaWkZSZXV5OFNaZWhyU2J0Y1A4cW5rRVBSc29qN3A3T2JnUUhnTStkTy9jZlBqTGpUNFBraForUFZvWnhqbHUwMU5FMjJiUFlET002S0RWaEZNZFFoYzA5aWRyTjNSb3BiZkZTakNKc1M0M0thS1J3eWREOGRHM0Zxa2tqaCtTcHFNaUs1eFdzTFdRPT0tLXc5eVdnYVJuRWNYYmpJcXlpeHhPU0E9PQ%3D%3D--84c2518f1c39e849574462eaa115e8870fa9e408; path=/; HttpOnly; SameSite=Lax" }, { "key": "X-Request-Id", "value": "551c6b51-b95e-407b-a0dc-6375b1c24b21" }, { "key": "X-Frame-Options", "value": "DENY" }, { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "X-XSS-Protection", "value": "1; mode=block" }, { "key": "X-Download-Options", "value": "noopen" }, { "key": "X-Permitted-Cross-Domain-Policies", "value": "none" }, { "key": "Referrer-Policy", "value": "strict-origin-when-cross-origin" }, { "key": "Transfer-Encoding", "value": "chunked" } ], "cookie": [], "body": "{\n \"status\": \"exceeds_limit\",\n \"message\": \"Request exceeds the limit of 100,000 entries in a single request\"\n}" }, { "name": "Error - Terminate list - Missing list ID", "originalRequest": { "method": "POST", "header": [ { "key": "Authorization", "type": "text", "value": "ApiKey: {{api_key}}" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"directive\": \"terminate\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base_host}}/api/v3/lists", "host": [ "{{base_host}}" ], "path": [ "api", "v3", "lists" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": null, "cookie": [], "body": "{\n \"status\": \"missing_data\",\n \"message\": \"Cannot terminate a list without a valid list id\"\n}" }, { "name": "Error - Uploads Not Complete", "originalRequest": { "method": "POST", "header": [ { "key": "Authorization", "type": "text", "value": "ApiKey: {{api_key}}" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"directive\": \"start\",\n \"contacts\": [\n { \n \"phone\": \"4444444444\",\n \"email\": \"hello@example.com\"\n },\n { \n \"phone\": \"5555555555\",\n \"email\": \"goodbye@example.com\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base_host}}/api/v3/lists", "host": [ "{{base_host}}" ], "path": [ "api", "v3", "lists" ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "Text", "header": null, "cookie": [], "body": "{\n status: \"list_uploads_incomplete\",\n message: \"Not ready to start. Input page uploads have not completed.\"\n}" } ] }, { "name": "Lists", "request": { "method": "GET", "header": [], "url": { "raw": "{{v3_base_url}}/api/v3/lists/", "host": [ "{{v3_base_url}}" ], "path": [ "api", "v3", "lists", "" ] }, "description": "Retrieves all lists from the past 7 days.\n\nFilterable by:\n* `external_id` (e.g. `/api/v2/accounts/your-customer-ID/lists`\n - _**Note:**_If a list uses `external_id`, the list will only be visible when that external_id is included in the GET URL. Otherwise, it does not appear in general list GETs. \n* `state` (e.g. `/api/v2/lists?state=completed`)\n* `page` (e.g. `/api/v2/lists?page=2`)\n* `date` (e.g. `/api/v2/lists?date=2020-07-28`)\n\nFilters can be combined to further narrow down retrieved lists." }, "response": [ { "name": "Get all lists", "originalRequest": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "type": "text", "value": "ApiKey: {{api_key}}" } ], "url": { "raw": "{{base_host}}/api/v3/lists", "host": [ "{{base_host}}" ], "path": [ "api", "v3", "lists" ] } }, "_postman_previewlanguage": "json", "header": null, "cookie": [], "body": "{\n \"lists\": [\n {\n \"id\": \"XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX\",\n \"state\": \"open\",\n \"total_verified\": 0,\n \"total_verified_emails\": 0,\n \"total_verified_phones\": 0,\n \"page_count\": 0,\n \"progress\": 0,\n \"created_at\": \"08-10-2021 04:26 pm\",\n \"expiration_date\": null,\n \"results_path\": null\n },\n {\n \"id\": \"XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX\",\n \"state\": \"complete\",\n \"total_verified\": 2,\n \"total_verified_emails\": 1,\n \"total_verified_phones\": 1,\n \"page_count\": 1,\n \"progress\": 100,\n \"created_at\": \"08-10-2021 04:26 pm\",\n \"expiration_date\": \"08-17-2021 04:26 pm\",\n \"results_path\": \"https://bulk-api.briteverify.com/api/v3/lists/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/export/1\"\n },\n {\n \"id\": \"XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX\",\n \"state\": \"terminated\",\n \"total_verified\": 0,\n \"total_verified_emails\": 0,\n \"total_verified_phones\": 0,\n \"page_count\": null,\n \"progress\": 0,\n \"created_at\": \"08-10-2021 04:03 pm\",\n \"expiration_date\": null,\n \"results_path\": null,\n \"errors\": [\n {\n \"code\": \"import_error\",\n \"message\": \"user terminated at 08-10-2021 04:07PM\"\n }\n ]\n }\n ]\n}" }, { "name": "Get lists - Multiple pages", "originalRequest": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "type": "text", "value": "ApiKey: {{api_key}}" } ], "url": { "raw": "{{base_host}}/api/v3/lists", "host": [ "{{base_host}}" ], "path": [ "api", "v3", "lists" ] } }, "_postman_previewlanguage": "json", "header": null, "cookie": [], "body": "{\n \"message\": \"Page 1 of 2\",\n \"lists\": [\n {\n \"id\": \"XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX\",\n \"state\": \"open\",\n \"total_verified\": 0,\n \"total_verified_emails\": 0,\n \"total_verified_phones\": 0,\n \"page_count\": 0,\n \"progress\": 0,\n \"created_at\": \"08-10-2021 04:26 pm\",\n \"expiration_date\": null,\n \"results_path\": null\n },\n {\n \"id\": \"XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX\",\n \"state\": \"complete\",\n \"total_verified\": 2,\n \"total_verified_emails\": 1,\n \"total_verified_phones\": 1,\n \"page_count\": 1,\n \"progress\": 100,\n \"created_at\": \"08-10-2021 04:26 pm\",\n \"expiration_date\": \"08-17-2021 04:26 pm\",\n \"results_path\": \"{{base_host}}/api/v3/lists/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/export/1\"\n },\n {\n \"id\": \"XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX\",\n \"state\": \"terminated\",\n \"total_verified\": 0,\n \"total_verified_emails\": 0,\n \"total_verified_phones\": 0,\n \"page_count\": null,\n \"progress\": 0,\n \"created_at\": \"08-10-2021 04:03 pm\",\n \"expiration_date\": null,\n \"results_path\": null,\n \"errors\": [\n {\n \"code\": \"import_error\",\n \"message\": \"user terminated at 08-10-2021 04:07PM\"\n }\n ]\n }\n ]\n}" }, { "name": "Get lists - Filter by page", "originalRequest": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "type": "text", "value": "ApiKey: {{api_key}}" } ], "url": { "raw": "{{base_host}}/api/v3/lists?page=2", "host": [ "{{base_host}}" ], "path": [ "api", "v3", "lists" ], "query": [ { "key": "page", "value": "2" } ] } }, "_postman_previewlanguage": "json", "header": null, "cookie": [], "body": "{\n \"message\": \"Page 2 of 2\",\n \"lists\": [\n {\n \"id\": \"XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX\",\n \"state\": \"open\",\n \"total_verified\": 0,\n \"total_verified_emails\": 0,\n \"total_verified_phones\": 0,\n \"page_count\": 0,\n \"progress\": 0,\n \"created_at\": \"08-10-2021 04:26 pm\",\n \"expiration_date\": null,\n \"results_path\": null\n },\n {\n \"id\": \"XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX\",\n \"state\": \"complete\",\n \"total_verified\": 2,\n \"total_verified_emails\": 1,\n \"total_verified_phones\": 1,\n \"page_count\": 1,\n \"progress\": 100,\n \"created_at\": \"08-10-2021 04:26 pm\",\n \"expiration_date\": \"08-17-2021 04:26 pm\",\n \"results_path\": \"{{base_host}}/api/v3/lists/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/export/1\"\n },\n {\n \"id\": \"XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX\",\n \"state\": \"terminated\",\n \"total_verified\": 0,\n \"total_verified_emails\": 0,\n \"total_verified_phones\": 0,\n \"page_count\": null,\n \"progress\": 0,\n \"created_at\": \"08-10-2021 04:03 pm\",\n \"expiration_date\": null,\n \"results_path\": null,\n \"errors\": [\n {\n \"code\": \"import_error\",\n \"message\": \"user terminated at 08-10-2021 04:07PM\"\n }\n ]\n }\n ]\n}" }, { "name": "Get lists - No lists found", "originalRequest": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "ApiKey: {{api_key}}", "type": "text" } ], "url": { "raw": "{{base_host}}/api/v3/lists", "host": [ "{{base_host}}" ], "path": [ "api", "v3", "lists" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Date", "value": "Wed, 27 May 2020 18:03:55 GMT" }, { "key": "Connection", "value": "close" }, { "key": "Content-Type", "value": "application/json; charset=utf-8" }, { "key": "ETag", "value": "W/\"fe8b08f609eeff7c989f60e1e2313f80\"" }, { "key": "Cache-Control", "value": "max-age=0, private, must-revalidate" }, { "key": "Set-Cookie", "value": "_bvapp_session=SFhucVJXN2pwTG5kVVZIYWlsZEN5bzZkK0RoLzB6dE5waU45ZzNjSm5yRFhQK2IvMldnaFVWWDA4U2xOOVRTT1pwanpOYm1aZUI3aFMzNGNpUWZuaHZyT1JFQjhUMzhjRVUwSDVPeVJQVWJ3TG1kYUlUcU11aGdZWkQwaStYcGJhRG5iMmtpM3ZhM0ZKcllmbjFiZnlnPT0tLW8rQWEybXpKam50RUEzOFVZdTduenc9PQ%3D%3D--cbfbbfb3f28f12c071e6c5e8aaf868f5ebc4dc68; path=/; HttpOnly; SameSite=Lax" }, { "key": "X-Request-Id", "value": "76c26adf-cecb-4597-82ac-c8c36dc57dab" }, { "key": "X-Frame-Options", "value": "DENY" }, { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "X-XSS-Protection", "value": "1; mode=block" }, { "key": "X-Download-Options", "value": "noopen" }, { "key": "X-Permitted-Cross-Domain-Policies", "value": "none" }, { "key": "Referrer-Policy", "value": "strict-origin-when-cross-origin" }, { "key": "Transfer-Encoding", "value": "chunked" } ], "cookie": [], "body": "{\n \"lists\": []\n}" }, { "name": "Get lists - Filter by external ID", "originalRequest": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "ApiKey: {{api_key}}", "type": "text" } ], "url": { "raw": "{{base_host}}/api/v3/accounts/12345/lists/", "host": [ "{{base_host}}" ], "path": [ "api", "v3", "accounts", "12345", "lists", "" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Date", "value": "Wed, 27 May 2020 18:01:09 GMT" }, { "key": "Connection", "value": "close" }, { "key": "Content-Type", "value": "application/json; charset=utf-8" }, { "key": "ETag", "value": "W/\"7b830c40db5d06076267710b8cc2bf38\"" }, { "key": "Cache-Control", "value": "max-age=0, private, must-revalidate" }, { "key": "Set-Cookie", "value": "_bvapp_session=MXV6QlR5REZQNmgvaDBZVUs3bUZTRTRzWktvbit3U0JtR3ZzR1hoK0R3MjM5Mm1VQ0piSXdwQWdCeitmaHFaeHJJSWNGZGxQTGxucTA0K2ErQUNoK1kwSDN4NjA3V2pXNHlENTBtWEk4QjFUZE1abUJZUExBN29SZEFkbXNieGJ6SGxjSjljRzdOYWRabDY4VWdWbTZnPT0tLU00QVBRR1E2MFdCUHFUM1dsSDlGQ0E9PQ%3D%3D--1b9f687b6cedf5bb0d91a0f6b48410a9d82c83b8; path=/; HttpOnly; SameSite=Lax" }, { "key": "X-Request-Id", "value": "d6d7d60b-dea2-4849-a868-fb0cb87262df" }, { "key": "X-Frame-Options", "value": "DENY" }, { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "X-XSS-Protection", "value": "1; mode=block" }, { "key": "X-Download-Options", "value": "noopen" }, { "key": "X-Permitted-Cross-Domain-Policies", "value": "none" }, { "key": "Referrer-Policy", "value": "strict-origin-when-cross-origin" }, { "key": "Transfer-Encoding", "value": "chunked" } ], "cookie": [], "body": "{\n \"lists\": [\n {\n \"id\": \"XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX\",\n \"state\": \"open\",\n \"total_verified\": 0,\n \"total_verified_emails\": 0,\n \"total_verified_phones\": 0,\n \"page_count\": 0,\n \"progress\": 0,\n \"created_at\": \"08-10-2021 04:26 pm\",\n \"expiration_date\": null,\n \"results_path\": null,\n \"account_external_id\": 12345\n },\n {\n \"id\": \"XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX\",\n \"state\": \"complete\",\n \"total_verified\": 2,\n \"total_verified_emails\": 1,\n \"total_verified_phones\": 1,\n \"page_count\": 1,\n \"progress\": 100,\n \"created_at\": \"08-10-2021 04:26 pm\",\n \"expiration_date\": \"08-17-2021 04:26 pm\",\n \"results_path\": \"{{base_host}}/api/v3/accounts/12345/lists/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/export/1\",\n \"account_external_id\": 12345\n },\n {\n \"id\": \"XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX\",\n \"state\": \"terminated\",\n \"total_verified\": 0,\n \"total_verified_emails\": 0,\n \"total_verified_phones\": 0,\n \"page_count\": null,\n \"progress\": 0,\n \"created_at\": \"08-10-2021 04:03 pm\",\n \"expiration_date\": null,\n \"results_path\": null,\n \"account_external_id\": 12345,\n \"errors\": [\n {\n \"code\": \"import_error\",\n \"message\": \"user terminated at 08-10-2021 04:07PM\"\n }\n ]\n\n }\n ]\n}" }, { "name": "Get lists - Filter by state", "originalRequest": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "type": "text", "value": "ApiKey: {{api_key}}" } ], "url": { "raw": "{{base_host}}/api/v3/lists?state=terminated", "host": [ "{{base_host}}" ], "path": [ "api", "v3", "lists" ], "query": [ { "key": "state", "value": "terminated" } ] } }, "_postman_previewlanguage": "json", "header": null, "cookie": [], "body": "{\n \"lists\": [\n {\n \"id\": \"XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX\",\n \"state\": \"terminated\",\n \"total_verified\": 0,\n \"total_verified_emails\": 0,\n \"total_verified_phones\": 0,\n \"page_count\": null,\n \"progress\": 0,\n \"created_at\": \"08-10-2021 04:03 pm\",\n \"expiration_date\": null,\n \"results_path\": null,\n \"errors\": [\n {\n \"code\": \"import_error\",\n \"message\": \"user terminated at 08-10-2021 04:07PM\"\n }\n ]\n }\n ]\n}" }, { "name": "Get lists - Filter by date", "originalRequest": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "ApiKey: {{api_key}}", "type": "text" } ], "url": { "raw": "{{base_host}}/api/v3/lists?date=2021-08-10", "host": [ "{{base_host}}" ], "path": [ "api", "v3", "lists" ], "query": [ { "key": "date", "value": "2021-08-10" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Date", "value": "Thu, 28 May 2020 16:10:21 GMT" }, { "key": "Connection", "value": "close" }, { "key": "Content-Type", "value": "application/json; charset=utf-8" }, { "key": "ETag", "value": "W/\"0115671ef8628f7ef9beb6e031268484\"" }, { "key": "Cache-Control", "value": "max-age=0, private, must-revalidate" }, { "key": "Set-Cookie", "value": "_bvapp_session=TTNOamFSWU1QUHFaTGRkbENjTXphZDVObmd5dmR4V2FiZDB5UkFmWUVKaTFvVGJqMWVEMWh0S3E4bWJhQ0VzUG5yellOSVNndENROThETG9nczQwdTR0UktpNXZLMHZvNzJZbmcvNTZ5K2hmTHYvSzZYSCtnZTI1NkpEQmJ3NmRTVElHMVkxUEZ1SCtMZFVwWEFBK2VRPT0tLU5xNDVSZ0xLd3Irb2NUamR5WDF3Y2c9PQ%3D%3D--968f2eea8afa15957f8f36af5304131a2264ca5a; path=/; HttpOnly; SameSite=Lax" }, { "key": "X-Request-Id", "value": "f6d85f0e-5ecf-4762-b0e9-785b5bd83acc" }, { "key": "X-Frame-Options", "value": "DENY" }, { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "X-XSS-Protection", "value": "1; mode=block" }, { "key": "X-Download-Options", "value": "noopen" }, { "key": "X-Permitted-Cross-Domain-Policies", "value": "none" }, { "key": "Referrer-Policy", "value": "strict-origin-when-cross-origin" }, { "key": "Transfer-Encoding", "value": "chunked" } ], "cookie": [], "body": "{\n \"lists\": [\n {\n \"id\": \"XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX\",\n \"state\": \"terminated\",\n \"total_verified\": 0,\n \"total_verified_emails\": 0,\n \"total_verified_phones\": 0,\n \"page_count\": null,\n \"progress\": 0,\n \"created_at\": \"08-10-2021 04:03 pm\",\n \"expiration_date\": null,\n \"results_path\": null,\n \"errors\": [\n {\n \"code\": \"import_error\",\n \"message\": \"user terminated at 08-10-2021 04:07PM\"\n }\n ]\n }\n ]\n}" } ] }, { "name": "List State", "request": { "method": "GET", "header": [], "url": { "raw": "{{v3_base_url}}/api/v3/lists/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "host": [ "{{v3_base_url}}" ], "path": [ "api", "v3", "lists", "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX" ] }, "description": "Fetches details on a specific list.\n\nUse this endpoint to check the verifying progress of the list. Once the list has completed, the results endpoint will be available." }, "response": [ { "name": "List state → Verifying", "originalRequest": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "ApiKey: {{api_key}}", "type": "text" } ], "url": { "raw": "{{base_host}}/api/v3/lists/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "host": [ "{{base_host}}" ], "path": [ "api", "v3", "lists", "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Date", "value": "Wed, 27 May 2020 01:36:03 GMT" }, { "key": "Connection", "value": "close" }, { "key": "Content-Type", "value": "application/json; charset=utf-8" }, { "key": "ETag", "value": "W/\"a02f9705c2708cb63f981f7c0f1bcf0b\"" }, { "key": "Cache-Control", "value": "max-age=0, private, must-revalidate" }, { "key": "Set-Cookie", "value": "_bvapp_session=c3hDWUhRQjBUS2JIcXlja1hVcEpXQ0RVRGhsRnRFK041MzIrTWxac0c2eVRhTWtTdWVaeUp1VzFsZGdCK3RybzREaDM3Z0VrZm1zbG9XcEJoc3h3cXFtSXBGdXgxekxMVkRMUUMydmQrekU0U2VodDZ1TWZIZFJ5WDkwNWZTNEE3RDVrb2ZMa2wvY2E0SnBQNGZpZ0hBPT0tLVRnQm1PczdHbTVVTXByYkZjYkxLTEE9PQ%3D%3D--3577e3c89022ae9bbc5df747d5731c97790a5de6; path=/; HttpOnly; SameSite=Lax" }, { "key": "X-Request-Id", "value": "1dad8779-cb3a-4fa7-8766-d254d1adde79" }, { "key": "X-Frame-Options", "value": "DENY" }, { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "X-XSS-Protection", "value": "1; mode=block" }, { "key": "X-Download-Options", "value": "noopen" }, { "key": "X-Permitted-Cross-Domain-Policies", "value": "none" }, { "key": "Referrer-Policy", "value": "strict-origin-when-cross-origin" }, { "key": "Transfer-Encoding", "value": "chunked" } ], "cookie": [], "body": "{\n \"id\": \"XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX\",\n \"state\": \"verifying\",\n \"total_verified\": 0,\n \"total_verified_emails\": 0,\n \"total_verified_phones\": 16,\n \"page_count\": 0,\n \"progress\": 0,\n \"created_at\": \"08-10-2021 05:08 pm\",\n \"expiration_date\": null,\n \"results_path\": null\n}" }, { "name": "List state → Complete", "originalRequest": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "ApiKey: {{api_key}}", "type": "text" } ], "url": { "raw": "{{base_host}}/api/v3/lists/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "host": [ "{{base_host}}" ], "path": [ "api", "v3", "lists", "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Date", "value": "Tue, 07 Jul 2020 21:01:37 GMT" }, { "key": "Content-Type", "value": "application/json; charset=utf-8" }, { "key": "Transfer-Encoding", "value": "chunked" }, { "key": "Connection", "value": "keep-alive" }, { "key": "ETag", "value": "W/\"84b65e2d5271408aefa4ece2605d775a\"" }, { "key": "Cache-Control", "value": "max-age=0, private, must-revalidate" }, { "key": "X-Request-Id", "value": "34184299-bba9-4197-9dc4-69b86d50e5ea" }, { "key": "X-Rack-Cache", "value": "pass" }, { "key": "Strict-Transport-Security", "value": "max-age=2592000; includeSubDomains" }, { "key": "X-Frame-Options", "value": "DENY" }, { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "X-XSS-Protection", "value": "1; mode=block" }, { "key": "X-Download-Options", "value": "noopen" }, { "key": "X-Permitted-Cross-Domain-Policies", "value": "none" }, { "key": "Referrer-Policy", "value": "strict-origin-when-cross-origin" }, { "key": "Content-Security-Policy", "value": "default-src 'self' 'unsafe-inline' https:; connect-src wss: https:; font-src data: https:; img-src data: https:; script-src 'self' 'unsafe-inline' 'unsafe-eval' https:" } ], "cookie": [], "body": "{\n \"id\": \"XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX\",\n \"state\": \"complete\",\n \"total_verified\": 32,\n \"total_verified_emails\": 16,\n \"total_verified_phones\": 16,\n \"page_count\": 1,\n \"progress\": 100,\n \"created_at\": \"08-10-2021 05:06 pm\",\n \"expiration_date\": \"08-17-2021 05:07 pm\",\n \"results_path\": \"{{base_host}}/api/v3/lists/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/export/1\"\n}" }, { "name": "List state → Terminated", "originalRequest": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "ApiKey: {{api_key}}", "type": "text" } ], "url": { "raw": "{{base_host}}/api/v3/lists/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "host": [ "{{base_host}}" ], "path": [ "api", "v3", "lists", "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Date", "value": "Wed, 27 May 2020 17:52:42 GMT" }, { "key": "Connection", "value": "close" }, { "key": "Content-Type", "value": "application/json; charset=utf-8" }, { "key": "ETag", "value": "W/\"08e3ff0c3deb1000baf82e7fa3c51d87\"" }, { "key": "Cache-Control", "value": "max-age=0, private, must-revalidate" }, { "key": "Set-Cookie", "value": "_bvapp_session=WG5uL2lPVDJsZXFRU2FVcWx6QVc1ZW9nTlIvZmNEQWwxUXFRSnI3aVlNM2IvYzhOV2FPZStxQ0kzQ2hUVm54Wkt0MmtvRktiUWlHc3ZqTC91Q1o1amQ0SHpTS0RhU1krYmxycUNLUHhNNG9WNVFvRGhuaWs2SCtHbSt0cXNXK2F5ZkViZWJXSDJqSXIwMG1zZmpreHZRPT0tLVhYNk1MNm85Mzkya3pOTVJlM05YWlE9PQ%3D%3D--4764f23fea81073f2ab47eb362d3f58e422bfb70; path=/; HttpOnly; SameSite=Lax" }, { "key": "X-Request-Id", "value": "2f305222-db23-43fc-a1f6-733477cf1b1e" }, { "key": "X-Frame-Options", "value": "DENY" }, { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "X-XSS-Protection", "value": "1; mode=block" }, { "key": "X-Download-Options", "value": "noopen" }, { "key": "X-Permitted-Cross-Domain-Policies", "value": "none" }, { "key": "Referrer-Policy", "value": "strict-origin-when-cross-origin" }, { "key": "Transfer-Encoding", "value": "chunked" } ], "cookie": [], "body": "{\n \"id\": \"XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX\",\n \"state\": \"terminated\",\n \"total_verified\": 0,\n \"total_verified_emails\": 0,\n \"total_verified_phones\": 0,\n \"page_count\": null,\n \"progress\": 0,\n \"created_at\": \"08-10-2021 04:03 pm\",\n \"expiration_date\": null,\n \"results_path\": null,\n \"errors\": [\n {\n \"code\": \"import_error\",\n \"message\": \"user terminated at 08-10-2021 04:07PM\"\n }\n ]\n}" }, { "name": "List state → Expired", "originalRequest": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "ApiKey: {{api_key}}", "type": "text" } ], "url": { "raw": "{{base_host}}/api/v3/lists/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "host": [ "{{base_host}}" ], "path": [ "api", "v3", "lists", "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Date", "value": "Wed, 27 May 2020 17:51:35 GMT" }, { "key": "Connection", "value": "close" }, { "key": "Content-Type", "value": "application/json; charset=utf-8" }, { "key": "ETag", "value": "W/\"20281962d08f1f24b4767a8a5ee4ba6c\"" }, { "key": "Cache-Control", "value": "max-age=0, private, must-revalidate" }, { "key": "Set-Cookie", "value": "_bvapp_session=dGRiaTFzYXZIWHE2NmZmMlZEemFmOTFmZzVSY3BSUHVKR2NtTEJLSEVxTTFBa1BTSHUvcTVHdS9STWRXcWxxRXR1VCtwanFLY1R4UDRRUXJka2lWQWxLa2R5dkFaZEVRSHovRXJBSkpsTjNPbTBIVlhhREhEZnVQb2RmU01Vem9uUGROK0E4N3FkMVhHYk9KOVRRSzZ3PT0tLVA3bEx0OE0zVmdWQ1B2cVAxTElJZkE9PQ%3D%3D--1b65da7f4bb206203182f6de5efbe051f4f38aa9; path=/; HttpOnly; SameSite=Lax" }, { "key": "X-Request-Id", "value": "f472675c-ae3c-4ff4-ad8e-5d22f8132808" }, { "key": "X-Frame-Options", "value": "DENY" }, { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "X-XSS-Protection", "value": "1; mode=block" }, { "key": "X-Download-Options", "value": "noopen" }, { "key": "X-Permitted-Cross-Domain-Policies", "value": "none" }, { "key": "Referrer-Policy", "value": "strict-origin-when-cross-origin" }, { "key": "Transfer-Encoding", "value": "chunked" } ], "cookie": [], "body": "{\n \"id\": \"XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX\",\n \"state\": \"complete\",\n \"total_verified\": 10,\n \"total_verified_emails\": 10,\n \"total_verified_phones\": 16,\n \"page_count\": 0,\n \"progress\": 0,\n \"created_at\": \"08-10-2021 05:08 pm\",\n \"expiration_date\": \"08-17-2021 05:08 pm\",\n \"results_path\": null,\n \"errors\": [\n {\n \"code\": \"expired\",\n \"message\": \"Expired. Download Unavailable.\"\n }\n ]\n}" }, { "name": "List state → Auto-terminated", "originalRequest": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "ApiKey: {{api_key}}", "type": "text" } ], "url": { "raw": "{{base_host}}/api/v3/lists/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "host": [ "{{base_host}}" ], "path": [ "api", "v3", "lists", "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Date", "value": "Wed, 27 May 2020 17:52:13 GMT" }, { "key": "Connection", "value": "close" }, { "key": "Content-Type", "value": "application/json; charset=utf-8" }, { "key": "ETag", "value": "W/\"3065552c1a6c707e56e2f10878858746\"" }, { "key": "Cache-Control", "value": "max-age=0, private, must-revalidate" }, { "key": "Set-Cookie", "value": "_bvapp_session=VzA3NVVrQWt6WTlaM2pRVjhsQThZaTl0YzluU0lveU92dWE3MGdQbCtFajFPUkZZcTluWHlUTFhkZ1o0MVo3K01MYTJDdzhpSzkrcE1yZWN3bXZBeVd1MnZ0Ymd5MEhRWHV2aGlWQTBjblNHelkwQ3ZGLzBtTWJwZE53YytIZnpNaWlRQjZ0WEtVYjd5Y3ZEOHZxK1d3PT0tLUJramduQ2FTcmxBUERMTzhZUDVQckE9PQ%3D%3D--df46b825c788333a1b8db3d1012d17311a97031a; path=/; HttpOnly; SameSite=Lax" }, { "key": "X-Request-Id", "value": "ea8a47f0-bd58-494f-93de-21e0467f365e" }, { "key": "X-Frame-Options", "value": "DENY" }, { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "X-XSS-Protection", "value": "1; mode=block" }, { "key": "X-Download-Options", "value": "noopen" }, { "key": "X-Permitted-Cross-Domain-Policies", "value": "none" }, { "key": "Referrer-Policy", "value": "strict-origin-when-cross-origin" }, { "key": "Transfer-Encoding", "value": "chunked" } ], "cookie": [], "body": "{\n \"id\": \"XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX\",\n \"state\": \"terminated\",\n \"counts\": 0,\n \"page_count\": null,\n \"progress\": 0,\n \"created_at\": \"06-15-2020 12:00 pm\",\n \"results_path\": null,\n \"errors\": [\n {\n \"code\": \"import_error\",\n \"message\": \"auto-terminated at 07-27-2020 01:00PM due to inactivity\"\n }\n ]\n}\n{\n \"id\": \"XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX\",\n \"state\": \"complete\",\n \"total_verified\": 10,\n \"total_verified_emails\": 10,\n \"total_verified_phones\": 16,\n \"page_count\": 0,\n \"progress\": 0,\n \"created_at\": \"08-10-2021 05:08 pm\",\n \"expiration_date\": null,\n \"results_path\": null,\n \"errors\": [\n {\n \"code\": \"import_error\",\n \"message\": \"auto-terminated at 08-15-2021 05:08 pm due to inactivity\"\n }\n ]\n ]\n}" }, { "name": "List state (with External ID)", "originalRequest": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "type": "text", "value": "ApiKey: {{api_key}}" } ], "url": { "raw": "{{base_host}}/api/v3/accounts/12345/lists/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "host": [ "{{base_host}}" ], "path": [ "api", "v3", "accounts", "12345", "lists", "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX" ] } }, "_postman_previewlanguage": "json", "header": null, "cookie": [], "body": "{\n \"id\": \"XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX\",\n \"state\": \"complete\",\n \"total_verified\": 2,\n \"total_verified_emails\": 1,\n \"total_verified_phones\": 1,\n \"page_count\": 1,\n \"progress\": 100,\n \"created_at\": \"08-10-2021 04:26 pm\",\n \"expiration_date\": \"08-17-2021 04:26 pm\",\n \"results_path\": \"{{base_host}}/api/v3/accounts/12345/lists/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX3/export/1\",\n \"account_external_id\": \"12345\"\n}" }, { "name": "Error - List not found", "originalRequest": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "ApiKey: {{api_key}}", "type": "text" } ], "url": { "raw": "{{base_host}}/api/v3/lists/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "host": [ "{{base_host}}" ], "path": [ "api", "v3", "lists", "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Date", "value": "Wed, 27 May 2020 17:08:23 GMT" }, { "key": "Connection", "value": "close" }, { "key": "Content-Type", "value": "application/json; charset=utf-8" }, { "key": "Cache-Control", "value": "no-cache" }, { "key": "Set-Cookie", "value": "_bvapp_session=YVVhTFBCajBZcFdJZ1A4TWRZQU5IU1JQVS9Lb3N3enJUcG4waTBCSVpyQzc2N25memNTdzNWcDRDMWVvNWFIcjRWa3RYdkNlRkRRN3NBWjZVVHg4Vm1mT0dQMFpNS0RPTjlvSXJTRWtIcWk3b1F4WmtmYVVwQVZ5aGRqS3NUNE03WXJmNTJnUWNkSG1FWmtTR2VuYkRnPT0tLTlTd2tPR3pWcjlYL041dWk0T0Yxa0E9PQ%3D%3D--ad7ac7def6e0b42b5a680f2c07856ba4d65bc892; path=/; HttpOnly; SameSite=Lax" }, { "key": "X-Request-Id", "value": "b405cbd4-4eeb-4de8-abd7-b75729ef06fd" }, { "key": "X-Frame-Options", "value": "DENY" }, { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "X-XSS-Protection", "value": "1; mode=block" }, { "key": "X-Download-Options", "value": "noopen" }, { "key": "X-Permitted-Cross-Domain-Policies", "value": "none" }, { "key": "Referrer-Policy", "value": "strict-origin-when-cross-origin" }, { "key": "Transfer-Encoding", "value": "chunked" } ], "cookie": [], "body": "{\n \"status\": \"not_found\",\n \"message\": \"No matching list found\"\n}" } ] }, { "name": "List Results", "request": { "method": "GET", "header": [], "url": { "raw": "{{v3_base_url}}/api/v3/lists/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/export/1", "host": [ "{{v3_base_url}}" ], "path": [ "api", "v3", "lists", "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "export", "1" ] }, "description": "Fetches the paged verification results for each email address in the list. A full list of email, phone, and mailing address statuses is available in the help center.\n\nExport link is available once list has finished verifying.\n\n
List return values:\n\nFor email:\n* `email`\n* `status`\n* `secondary_status`\n\nFor phone:\n* `phone`\n* `status`\n* `secondary_status`\n* `phone_service_type`\n* `phone_location`" }, "response": [ { "name": "Get list results (contacts parameter)", "originalRequest": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "type": "text", "value": "ApiKey: {{api_key}}" } ], "url": { "raw": "{{base_host}}/api/v3/lists/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/export/1", "host": [ "{{base_host}}" ], "path": [ "api", "v3", "lists", "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "export", "1" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Date", "value": "Thu, 28 May 2020 16:04:35 GMT" }, { "key": "Connection", "value": "close" }, { "key": "Content-Type", "value": "application/json; charset=utf-8" }, { "key": "ETag", "value": "W/\"07681babff0a8cad00003c46c3563f4e\"" }, { "key": "Cache-Control", "value": "max-age=0, private, must-revalidate" }, { "key": "Set-Cookie", "value": "_bvapp_session=R3BRMDJNdzl0WVBiY2dVRE1YbjEyTU9saUVOcGM4eElsb0V0MXJYbHJ4aktrM0k0eExrUTVFaFQvMTJkbkhPcm5VYUt5SkdEazlaZFloc0ZyUU56UDVOU2U1c3grM0ZXajZxdy91RkhIcmpJUFRDMTRubFRuN3VxcEJiS0VpUytwS0FXdU1TTDlLZG9UQTdYSE92N0VRPT0tLWhORFk4WU5nZzhJVHh1eU14YjBYOVE9PQ%3D%3D--0b83d22b8e5566b97eb6b91ee7afe57b37affceb; path=/; HttpOnly; SameSite=Lax" }, { "key": "X-Request-Id", "value": "7a5974ec-2bc1-423d-ba6d-3d3e00b0d222" }, { "key": "X-Frame-Options", "value": "DENY" }, { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "X-XSS-Protection", "value": "1; mode=block" }, { "key": "X-Download-Options", "value": "noopen" }, { "key": "X-Permitted-Cross-Domain-Policies", "value": "none" }, { "key": "Referrer-Policy", "value": "strict-origin-when-cross-origin" }, { "key": "Transfer-Encoding", "value": "chunked" } ], "cookie": [], "body": "{\n \"status\": \"success\",\n \"num_pages\": 1,\n \"results\": [\n {\n \"email\": {\n \"email\": \"sales@validity.com\",\n \"status\": \"valid\",\n \"secondary_status\": \"role_address\"\n },\n \"phone\": {\n \"phone\": \"18009618205\",\n \"status\": \"valid\",\n \"secondary_status\": null,\n \"phone_service_type\": \"land\",\n \"phone_location\": null\n },\n \"address\": {\n \"address1\": \"200 Clarendon St Ste 2200\",\n \"address2\": null,\n \"city\": \"Boston\",\n \"state\": \"MA\",\n \"zip\": \"02116-5051\",\n \"status\": \"valid\",\n \"secondary_status\": null,\n \"corrected\": \"true\"\n }\n },\n {\n \"email\": {\n \"email\": \"goodbye@example.com\",\n \"status\": \"invalid\",\n \"secondary_status\": \"email_domain_invalid\"\n },\n \"phone\": {\n \"phone\": \"5555555555\",\n \"status\": \"invalid\",\n \"secondary_status\": \"invalid_phone_number\",\n \"phone_service_type\": null,\n \"phone_location\": null\n }\n }\n ]\n}" }, { "name": "Get list results (emails parameter)", "originalRequest": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "type": "text", "value": "ApiKey: {{api_key}}" } ], "url": { "raw": "{{base_host}}/api/v3/lists/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/export/1", "host": [ "{{base_host}}" ], "path": [ "api", "v3", "lists", "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "export", "1" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Date", "value": "Thu, 28 May 2020 16:04:35 GMT" }, { "key": "Connection", "value": "close" }, { "key": "Content-Type", "value": "application/json; charset=utf-8" }, { "key": "ETag", "value": "W/\"07681babff0a8cad00003c46c3563f4e\"" }, { "key": "Cache-Control", "value": "max-age=0, private, must-revalidate" }, { "key": "Set-Cookie", "value": "_bvapp_session=R3BRMDJNdzl0WVBiY2dVRE1YbjEyTU9saUVOcGM4eElsb0V0MXJYbHJ4aktrM0k0eExrUTVFaFQvMTJkbkhPcm5VYUt5SkdEazlaZFloc0ZyUU56UDVOU2U1c3grM0ZXajZxdy91RkhIcmpJUFRDMTRubFRuN3VxcEJiS0VpUytwS0FXdU1TTDlLZG9UQTdYSE92N0VRPT0tLWhORFk4WU5nZzhJVHh1eU14YjBYOVE9PQ%3D%3D--0b83d22b8e5566b97eb6b91ee7afe57b37affceb; path=/; HttpOnly; SameSite=Lax" }, { "key": "X-Request-Id", "value": "7a5974ec-2bc1-423d-ba6d-3d3e00b0d222" }, { "key": "X-Frame-Options", "value": "DENY" }, { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "X-XSS-Protection", "value": "1; mode=block" }, { "key": "X-Download-Options", "value": "noopen" }, { "key": "X-Permitted-Cross-Domain-Policies", "value": "none" }, { "key": "Referrer-Policy", "value": "strict-origin-when-cross-origin" }, { "key": "Transfer-Encoding", "value": "chunked" } ], "cookie": [], "body": "{\n \"status\":\"success\",\n \"num_pages\":\"2\",\n \"results\": [\n {\n \"email\": \"invalid@test.com\",\n \"status\": \"invalid\",\n \"secondary_status\": \"email_account_invalid\"\n },\n {\n \"email\": \"unknown@test.com\",\n \"status\": \"unknown\",\n \"secondary_status\": null\n },\n {\n \"email\": \"valid@test.com\",\n \"status\": \"valid\",\n \"secondary_status\": \"role_address\"\n },\n {\n \"email\": \"accept_all@test.com\",\n \"status\": \"accept_all\",\n \"secondary_status\": \"role_address\"\n }\n ]\n}" }, { "name": "Get list results - Last page", "originalRequest": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "type": "text", "value": "ApiKey: {{api_key}}" } ], "url": { "raw": "{{base_host}}/api/v3/lists/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/export/2", "host": [ "{{base_host}}" ], "path": [ "api", "v3", "lists", "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "export", "2" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Date", "value": "Thu, 28 May 2020 16:05:16 GMT" }, { "key": "Connection", "value": "close" }, { "key": "Content-Type", "value": "application/json; charset=utf-8" }, { "key": "ETag", "value": "W/\"383a687aef5945b48e9ef4b1cc1a3e4d\"" }, { "key": "Cache-Control", "value": "max-age=0, private, must-revalidate" }, { "key": "Set-Cookie", "value": "_bvapp_session=Rm0zbUllZnByVHd1Yk1oTkJUQXNjMDUzeWlzRzRSdGFpekhiT1F1MzJTVFEzbW5hMDJ6ZWs1aGswNWtLUlQvUXR1Q3pNUVduNmVnclc3NXdNVEFQL0pRTE1HVCtGbk1NZzdFM3U3YkU4TVd2RDNKcmtZdk02ZDlPOTd5VllwcGFUdDN6N0xxYVVGK1dwUStTY08zekZnPT0tLUFkOW96R0tXZUFwRy8wNVhqcWN6RWc9PQ%3D%3D--3b4c5af5a6fe8ec019427ac2b2a4c92d5f2883e3; path=/; HttpOnly; SameSite=Lax" }, { "key": "X-Request-Id", "value": "7b2f40cb-299e-4e63-8902-c3b4c6488664" }, { "key": "X-Frame-Options", "value": "DENY" }, { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "X-XSS-Protection", "value": "1; mode=block" }, { "key": "X-Download-Options", "value": "noopen" }, { "key": "X-Permitted-Cross-Domain-Policies", "value": "none" }, { "key": "Referrer-Policy", "value": "strict-origin-when-cross-origin" }, { "key": "Transfer-Encoding", "value": "chunked" } ], "cookie": [], "body": "{\n \"status\": \"success\",\n \"num_pages\": 2,\n \"results\": [\n {\n \"email\": {\n \"email\": \"john.doe@email.com\",\n \"status\": \"valid\",\n \"secondary_status\": null\n },\n \"phone\": {\n \"phone\": \"4444444444\",\n \"status\": \"valid\",\n \"secondary_status\": null,\n \"phone_service_type\": \"mobile\",\n \"phone_location\": null\n }\n },\n {\n \"email\": {\n \"email\": \"jane.doe@email.com\",\n \"status\": \"valid\",\n \"secondary_status\": null\n },\n \"phone\": {\n \"phone\": \"5555555555\",\n \"status\": \"valid\",\n \"secondary_status\": null,\n \"phone_service_type\": \"mobile\",\n \"phone_location\": null\n }\n },\n {\n \"email\": {\n \"email\": \"jim.doe@email.com\",\n \"status\": \"valid\",\n \"secondary_status\": null\n },\n \"phone\": {\n \"phone\": \"6666666666\",\n \"status\": \"valid\",\n \"secondary_status\": null,\n \"phone_service_type\": \"mobile\",\n \"phone_location\": null\n }\n }\n ]\n}" }, { "name": "Get list results - Expired", "originalRequest": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "type": "text", "value": "ApiKey: {{api_key}}" } ], "url": { "raw": "{{base_host}}/api/v3/lists/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/export/1", "host": [ "{{base_host}}" ], "path": [ "api", "v3", "lists", "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "export", "1" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Date", "value": "Wed, 27 May 2020 15:37:38 GMT" }, { "key": "Connection", "value": "close" }, { "key": "Content-Type", "value": "application/json; charset=utf-8" }, { "key": "Cache-Control", "value": "no-cache" }, { "key": "Set-Cookie", "value": "_bvapp_session=WDBROWd1OVZMUFhJdGZ4UzNFcjJMaVAvV2JqK2w4NEx5cUJTQmtuRC9YSUU2OWFpckZyYlE4NGVKNFNCL2x3M0NJelNmOVZuVHYvUUtPTUQwaFMrR2FCam1KUzV4RVJReWg2c2RYMHRmY1hSbENyWVpIZldHejVORGU2WUZkNnVTaWNFckU5N21Gd3IyNldsM2RrR25nPT0tLTdvbXQzMlRBWnNjOXJDU2JPRVRRaVE9PQ%3D%3D--abb6d50d8a2827b1ad35bd9ed6eb3d5d60640c01; path=/; HttpOnly; SameSite=Lax" }, { "key": "X-Request-Id", "value": "eedd59dd-01bd-4117-a819-1daeb56ff5b7" }, { "key": "X-Frame-Options", "value": "DENY" }, { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "X-XSS-Protection", "value": "1; mode=block" }, { "key": "X-Download-Options", "value": "noopen" }, { "key": "X-Permitted-Cross-Domain-Policies", "value": "none" }, { "key": "Referrer-Policy", "value": "strict-origin-when-cross-origin" }, { "key": "Transfer-Encoding", "value": "chunked" } ], "cookie": [], "body": "{ \n \"status\": \"list_expired\", \n \"message\": \"List with id XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX has expired.\" \n}" }, { "name": "Error - Page not found", "originalRequest": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "type": "text", "value": "ApiKey: {{api_key}}" } ], "url": { "raw": "{{base_host}}/api/v3/lists/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/export/2", "host": [ "{{base_host}}" ], "path": [ "api", "v3", "lists", "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "export", "2" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Date", "value": "Wed, 27 May 2020 18:31:05 GMT" }, { "key": "Connection", "value": "close" }, { "key": "Content-Type", "value": "application/json; charset=utf-8" }, { "key": "Cache-Control", "value": "no-cache" }, { "key": "Set-Cookie", "value": "_bvapp_session=TkRyWEMzVjJIVG9tdVFlYzg2dmhBUlB4ZFc5ajRYdEZwbFd4OExiQm81aXRnYTRhUGVLSmpNRnhjRFB5TVRXSVgxcWU2TEI2bnZqYmovOFVjTDZDNzdZZlJBK3pqZ3dPdGNZeGREak1SbHJpTnNwY3Yvc0NYUlg3N2gwWjhCVmp4WFMrTFdFaTRRMFBEWWhEK2VpMXZRPT0tLWJwQ0g0Y01xcm5Fc2lTaG8wNjJBV3c9PQ%3D%3D--52f1dc5fbf9a3bd75c046144b0671d970630ceb5; path=/; HttpOnly; SameSite=Lax" }, { "key": "X-Request-Id", "value": "6b56529f-0100-4a3c-8fcd-6f0f66a7dfec" }, { "key": "X-Frame-Options", "value": "DENY" }, { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "X-XSS-Protection", "value": "1; mode=block" }, { "key": "X-Download-Options", "value": "noopen" }, { "key": "X-Permitted-Cross-Domain-Policies", "value": "none" }, { "key": "Referrer-Policy", "value": "strict-origin-when-cross-origin" }, { "key": "Transfer-Encoding", "value": "chunked" } ], "cookie": [], "body": "{\n \"status\": \"invalid_page_number\",\n \"message\": \"Page number 2 invalid.\"\n}" }, { "name": "Error - List not found", "originalRequest": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "type": "text", "value": "ApiKey: {{api_key}}" } ], "url": { "raw": "{{base_host}}/api/v3/lists/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/export/1", "host": [ "{{base_host}}" ], "path": [ "api", "v3", "lists", "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "export", "1" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Date", "value": "Wed, 27 May 2020 15:37:20 GMT" }, { "key": "Connection", "value": "close" }, { "key": "Content-Type", "value": "application/json; charset=utf-8" }, { "key": "Cache-Control", "value": "no-cache" }, { "key": "Set-Cookie", "value": "_bvapp_session=ZEttWnRPbHFvWU5VSWdURzZFMHdnYVluR0xTRzVYZFhwMXVBYktpUlFLMFJXUWZDR1dEWStGazV6YWg1UEpRbGFHUWdPMGF0TkVxem95TVpzYmMwZEtCRjVRNXg2M3lLUUVnVUxaS1RJNkwxMUlNOVVCZzNjRlZEdEtiamhmMEFkOFBGcVg2WGdNU09ha2F2c3hSUm1BPT0tLTZUWXVyQ01ocVBtSm81WkE2WWxPRmc9PQ%3D%3D--24c7ec4c097cc755a34e4eff14472629de3d538c; path=/; HttpOnly; SameSite=Lax" }, { "key": "X-Request-Id", "value": "18343f36-971d-416e-9e1a-b3d0bbc79bd8" }, { "key": "X-Frame-Options", "value": "DENY" }, { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "X-XSS-Protection", "value": "1; mode=block" }, { "key": "X-Download-Options", "value": "noopen" }, { "key": "X-Permitted-Cross-Domain-Policies", "value": "none" }, { "key": "Referrer-Policy", "value": "strict-origin-when-cross-origin" }, { "key": "Transfer-Encoding", "value": "chunked" } ], "cookie": [], "body": "{\n \"status\": \"not_found\",\n \"message\": \"No matching list found.\"\n}" } ] }, { "name": "List Delete", "request": { "method": "DELETE", "header": [], "url": { "raw": "{{v3_base_url}}/api/v3/lists/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "host": [ "{{v3_base_url}}" ], "path": [ "api", "v3", "lists", "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX" ] }, "description": "Deleting a specific list.\n\nUse this endpoint to delete a list. Once this deletion has been completed, the list will no longer exist. Once completed, this action cannot be reversed.\n\nThe list must be in one of the following `states` to be deleted:\n\n* `Complete`\n* `Delivered`\n* `Prepped`\n* `Import_error`" }, "response": [ { "name": "List State → Complete", "originalRequest": { "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "type": "text", "value": "ApiKey: {{api_key}}" } ], "url": { "raw": "{{base_host}}/api/v3/lists/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "host": [ "{{base_host}}" ], "path": [ "api", "v3", "lists", "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "Text", "header": [ { "key": "Date", "value": "Thu, 21 Jul 2022 18:16:05 GMT" }, { "key": "Content-Type", "value": "application/json; charset=utf-8" }, { "key": "Transfer-Encoding", "value": "chunked" }, { "key": "Connection", "value": "keep-alive" }, { "key": "ETag", "value": "W/\"2b5aaec7ba71463e4da15a2d13cec4b9\"" }, { "key": "Cache-Control", "value": "max-age=0, private, must-revalidate" }, { "key": "X-Request-Id", "value": "29083613-164c-412f-8242-539abb64d91e" }, { "key": "X-Rack-Cache", "value": "pass" }, { "key": "Strict-Transport-Security", "value": "max-age=15552000; includeSubDomains" }, { "key": "X-Frame-Options", "value": "DENY" }, { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "X-XSS-Protection", "value": "1; mode=block" }, { "key": "X-Download-Options", "value": "noopen" }, { "key": "X-Permitted-Cross-Domain-Policies", "value": "none" }, { "key": "Referrer-Policy", "value": "strict-origin-when-cross-origin" }, { "key": "Content-Security-Policy", "value": "default-src 'self' 'unsafe-inline' https:; connect-src wss: https:; font-src data: https:; img-src data: https:; script-src 'self' 'unsafe-inline' 'unsafe-eval' https:" } ], "cookie": [], "body": "{\n \"status\": \"success\",\n \"list\": {\n \"id\": \"XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX\",\n \"state\": \"deleted\",\n \"total_verified\": 32,\n \"total_verified_emails\": 16,\n \"total_verified_phones\": 16,\n \"page_count\": 1,\n \"progress\": 100,\n \"created_at\": \"07-18-2022 12:42 pm\",\n \"expiration_date\": null,\n \"results_path\": null\n }\n}" }, { "name": "List State → Delivered", "originalRequest": { "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "type": "text", "value": "ApiKey: {{api_key}}" } ], "url": { "raw": "{{base_host}}/api/v3/lists/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "host": [ "{{base_host}}" ], "path": [ "api", "v3", "lists", "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX" ] } }, "_postman_previewlanguage": "Text", "header": [ { "key": "Date", "value": "Thu, 21 Jul 2022 18:28:37 GMT" }, { "key": "Content-Type", "value": "application/json; charset=utf-8" }, { "key": "Transfer-Encoding", "value": "chunked" }, { "key": "Connection", "value": "keep-alive" }, { "key": "ETag", "value": "W/\"5c37f7fe46769ac8e4d8f65779e18c39\"" }, { "key": "Cache-Control", "value": "max-age=0, private, must-revalidate" }, { "key": "X-Request-Id", "value": "85fc5693-a320-406c-ab72-2dde3a4854e7" }, { "key": "X-Rack-Cache", "value": "pass" }, { "key": "Strict-Transport-Security", "value": "max-age=15552000; includeSubDomains" }, { "key": "X-Frame-Options", "value": "DENY" }, { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "X-XSS-Protection", "value": "1; mode=block" }, { "key": "X-Download-Options", "value": "noopen" }, { "key": "X-Permitted-Cross-Domain-Policies", "value": "none" }, { "key": "Referrer-Policy", "value": "strict-origin-when-cross-origin" }, { "key": "Content-Security-Policy", "value": "default-src 'self' 'unsafe-inline' https:; connect-src wss: https:; font-src data: https:; img-src data: https:; script-src 'self' 'unsafe-inline' 'unsafe-eval' https:" } ], "cookie": [], "body": "{\n \"status\": \"success\",\n \"list\": {\n \"id\": \"XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX\",\n \"state\": \"deleted\",\n \"total_verified\": 32,\n \"total_verified_emails\": 16,\n \"total_verified_phones\": 16,\n \"page_count\": 1,\n \"progress\": 100,\n \"created_at\": \"07-18-2022 12:42 pm\",\n \"expiration_date\": null,\n \"results_path\": null\n }\n}" }, { "name": "List State → Prepped", "originalRequest": { "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "type": "text", "value": "ApiKey: {{api_key}}" } ], "url": { "raw": "{{base_host}}/api/v3/lists/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "host": [ "{{base_host}}" ], "path": [ "api", "v3", "lists", "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX" ] } }, "_postman_previewlanguage": "Text", "header": [ { "key": "Date", "value": "Thu, 21 Jul 2022 18:23:20 GMT" }, { "key": "Content-Type", "value": "application/json; charset=utf-8" }, { "key": "Transfer-Encoding", "value": "chunked" }, { "key": "Connection", "value": "keep-alive" }, { "key": "ETag", "value": "W/\"7a0277a8e0d8380e03f80c94b81c60c1\"" }, { "key": "Cache-Control", "value": "max-age=0, private, must-revalidate" }, { "key": "X-Request-Id", "value": "ac149749-c96d-4734-b6e0-3de412d66d22" }, { "key": "X-Rack-Cache", "value": "pass" }, { "key": "Strict-Transport-Security", "value": "max-age=15552000; includeSubDomains" }, { "key": "X-Frame-Options", "value": "DENY" }, { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "X-XSS-Protection", "value": "1; mode=block" }, { "key": "X-Download-Options", "value": "noopen" }, { "key": "X-Permitted-Cross-Domain-Policies", "value": "none" }, { "key": "Referrer-Policy", "value": "strict-origin-when-cross-origin" }, { "key": "Content-Security-Policy", "value": "default-src 'self' 'unsafe-inline' https:; connect-src wss: https:; font-src data: https:; img-src data: https:; script-src 'self' 'unsafe-inline' 'unsafe-eval' https:" } ], "cookie": [], "body": "{\n \"status\": \"success\",\n \"list\": {\n \"id\": \"XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX\",\n \"state\": \"deleted\",\n \"total_verified\": 32,\n \"total_verified_emails\": 16,\n \"total_verified_phones\": 16,\n \"page_count\": 1,\n \"progress\": 100,\n \"created_at\": \"07-18-2022 12:42 pm\",\n \"expiration_date\": null,\n \"results_path\": null\n }\n}" }, { "name": "List State → Import_error", "originalRequest": { "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "type": "text", "value": "ApiKey: {{api_key}}" } ], "url": { "raw": "{{base_host}}/api/v3/lists/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "host": [ "{{base_host}}" ], "path": [ "api", "v3", "lists", "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX" ] } }, "_postman_previewlanguage": "Text", "header": [ { "key": "Date", "value": "Thu, 21 Jul 2022 18:26:28 GMT" }, { "key": "Content-Type", "value": "application/json; charset=utf-8" }, { "key": "Transfer-Encoding", "value": "chunked" }, { "key": "Connection", "value": "keep-alive" }, { "key": "ETag", "value": "W/\"7316f8728575bc63a693a40890d922ba\"" }, { "key": "Cache-Control", "value": "max-age=0, private, must-revalidate" }, { "key": "X-Request-Id", "value": "9ee775f0-29d3-4a99-a883-77b53f81aa4c" }, { "key": "X-Rack-Cache", "value": "pass" }, { "key": "Strict-Transport-Security", "value": "max-age=15552000; includeSubDomains" }, { "key": "X-Frame-Options", "value": "DENY" }, { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "X-XSS-Protection", "value": "1; mode=block" }, { "key": "X-Download-Options", "value": "noopen" }, { "key": "X-Permitted-Cross-Domain-Policies", "value": "none" }, { "key": "Referrer-Policy", "value": "strict-origin-when-cross-origin" }, { "key": "Content-Security-Policy", "value": "default-src 'self' 'unsafe-inline' https:; connect-src wss: https:; font-src data: https:; img-src data: https:; script-src 'self' 'unsafe-inline' 'unsafe-eval' https:" } ], "cookie": [], "body": "{\n \"status\": \"success\",\n \"list\": {\n \"id\": \"XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX\",\n \"state\": \"deleted\",\n \"total_verified\": 32,\n \"total_verified_emails\": 16,\n \"total_verified_phones\": 16,\n \"page_count\": 1,\n \"progress\": 100,\n \"created_at\": \"07-18-2022 12:42 pm\",\n \"expiration_date\": null,\n \"results_path\": null\n }\n}" }, { "name": "Error - Invalid List State", "originalRequest": { "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "type": "text", "value": "ApiKey: {{api_key}}" } ], "url": { "raw": "{{base_host}}/api/v3/lists/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "host": [ "{{base_host}}" ], "path": [ "api", "v3", "lists", "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "Text", "header": [ { "key": "Date", "value": "Thu, 21 Jul 2022 18:18:42 GMT" }, { "key": "Content-Type", "value": "json/error; charset=utf-8" }, { "key": "Transfer-Encoding", "value": "chunked" }, { "key": "Connection", "value": "keep-alive" }, { "key": "Cache-Control", "value": "no-cache" }, { "key": "X-Request-Id", "value": "ccc7301d-335b-4b78-aabf-e05da4189a20" }, { "key": "X-Rack-Cache", "value": "pass" }, { "key": "Strict-Transport-Security", "value": "max-age=15552000; includeSubDomains" }, { "key": "X-Frame-Options", "value": "DENY" }, { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "X-XSS-Protection", "value": "1; mode=block" }, { "key": "X-Download-Options", "value": "noopen" }, { "key": "X-Permitted-Cross-Domain-Policies", "value": "none" }, { "key": "Referrer-Policy", "value": "strict-origin-when-cross-origin" }, { "key": "Content-Security-Policy", "value": "default-src 'self' 'unsafe-inline' https:; connect-src wss: https:; font-src data: https:; img-src data: https:; script-src 'self' 'unsafe-inline' 'unsafe-eval' https:" } ], "cookie": [], "body": "{\n \"status\": \"invalid_state\",\n \"message\": \"The provided list is in an invalid state -- state is verifying and needs to be one of the following to continue: complete, delivered, prepped, import_error.\"\n}" } ] } ] } ], "description": "The BriteVerify Bulk Verification API (v3) is a simple, RESTful web service built for performing email and phone address verifications at speed and scale. It's ideal for verifying databases or lists.\n\n**Verifications Types Available:**\n\n* Email Addresses\n* Phone numbers (U.S. and Canadian)\n* Mailing Addresses (U.S. and Canadian)\n \n\n**Whole-contact Verification**\n\nIn addition to the `emails` object from v2, this API features a new `contacts` object, which supports email address, U.S. and Canadian phone number, and U.S. and Canadian mailing address verification within the same object.\n\n* ***Note:*** *You can only use one object type (**`emails`* *or* *`contacts`**) per list, so consider whether you only need email addresses, or if you might expand to phone numbers and/or mailing addresses in the future.*\n \n\n**Paging** \nFor lists larger than 100,000 contacts (each containing one email address and/or one phone number), use paging to upload the list in chunks (see Append to list).\n\n* ***Note:*** *When adding pages to an open list, responses will not give you a running total of the items you have added. You can only get confirmation of your total verifications after the verification process has completed.*\n \n\nAfter the initial list creation, a list will remain open to allow you to continue to add to it. After 15 minutes of inactivity, the list will automatically terminate.\n\nSee above for information on [Performance, Usage, & Rate Limits](https://docs.briteverify.com/#intro)\n\nTo learn more about statuses returned, see [Response Statuses & Errors](https://help.returnpath.com/hc/en-us/articles/360047111771-Understanding-Statuses-in-BriteVerify)." } ] } ], "auth": { "type": "apikey", "apikey": [ { "key": "value", "value": "ApiKey: {{api_key}}", "type": "string" }, { "key": "key", "value": "Authorization", "type": "string" } ] }, "variable": [ { "key": "api_key", "value": "YOUR API KEY", "type": "string" }, { "key": "v1_base_url", "value": "https://bpi.briteverify.com", "type": "string" }, { "key": "v3_base_url", "value": "https://bulk-api.briteverify.com", "type": "string" } ] }