{"_id":"56157ca5f432910d0000fa04","project":"55c80e130300460d00c91c1d","__v":23,"parentDoc":null,"user":"55c80d9f0300460d00c91c1a","category":{"_id":"561312bc41a9ec0d00a3fdfc","pages":["561312db41a9ec0d00a3fdfe","561312efbe80130d00f188db","56131308cf8d220d0057f459","5613e16c3291f10d00d42b80","56157ca5f432910d0000fa04","569fd0345b981c2b00383dbc"],"version":"55cba6d237edd823001a85d7","__v":6,"project":"55c80e130300460d00c91c1d","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-10-06T00:15:56.873Z","from_sync":false,"order":3,"slug":"open-supporter-data-interface","title":"OPEN SUPPORTER DATA INTERFACE"},"version":{"_id":"55cba6d237edd823001a85d7","project":"55c80e130300460d00c91c1d","__v":3,"createdAt":"2015-08-12T20:04:34.776Z","releaseDate":"2015-08-12T20:04:34.776Z","categories":["55cba6d337edd823001a85d8","55cba6d337edd823001a85d9","55cba6d337edd823001a85da","55cba6d337edd823001a85db","55cbd8e84cf2180d00bb1c15","561312bc41a9ec0d00a3fdfc"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"2.0.0","version":"2"},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-10-07T20:12:21.206Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":1,"body":"[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Features\"\n}\n[/block]\n- Features a complete syntactical email validation engine that obeys current IETF standards, including RFC 1123, RFC 2821, RFC 2822, RFC 3490, RFC 3696, RFC 4291, RFC 5321, RFC 5322 and RFC 5336.\n\n- Detects temporary email addresses generated by certain free services on the Internet, collectively known as disposable email address providers.\n\n- Actively verifies delivery status of email addresses and flags known SPAM traps and inboxes that are simply out of space. \n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Getting Started\"\n}\n[/block]\nAPI Endpoint is http://api.accurateappend.com/OSDI/V1/VerifyEmails\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Tutorial: Making A Request\"\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Note:\",\n  \"body\": \"Keep your API key secret. Anyone with your API key will be able to access any data in your account. Therefore, the Accurate Append API is not suitable for front end-only implementations (such as a JavaScript and jQuery client) because this could expose your API key to others.\\n\\nThis API is a proprietary extension to the OSDI specification. It leverages the payload format of osdi:email_address structure to support verification.\"\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Call the operation with a OSDI Person object\"\n}\n[/block]\nValidate Email will attempt to validate all emails contained in the email_addresses collection in the Person object passed in the request. \n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"curl -i \\n  -H \\\"Accept: application/json\\\" -H \\\"Content-Type: application/json\\\" \\n  -H \\\"OSDI-API-Token: [Your API key]\\\" \\n  -X POST \\n  -d \\\"{  \\n         \\\"identifiers\\\":[  \\n            \\\"osdi_sample_system:d91b4b2e-ae0e-4cd3-9ed7-d0ec501b0bc3\\\",\\n            \\\"foreign_system:1\\\"\\n         ],\\n         \\\"given_name\\\":\\\"John\\\",\\n         \\\"family_name\\\":\\\"Smith\\\",\\n         \\\"additional_name\\\":\\\"Scott\\\",\\n         \\\"gender\\\":\\\"Male\\\",\\n         \\\"gender_identity\\\":\\\"Male\\\",\\n         \\\"birthdate\\\":{  \\n            \\\"month\\\":6,\\n            \\\"day\\\":2,\\n            \\\"year\\\":1973\\n         },\\n         \\\"ethnicities\\\":[  \\n            \\\"African American\\\"\\n         ],\\n         \\\"email_addresses\\\":[  \\n            {  \\n               \\\"primary\\\":true,\\n               \\\"address\\\":\\\"johnsmith:::at:::mail.com\\\",\\n               \\\"address_type\\\":\\\"personal\\\",\\n               \\\"status\\\":\\\"subscribed\\\"\\n            },\\n            {  \\n               \\\"address\\\":\\\"john.smith@gmail.com\\\",\\n               \\\"address_type\\\":\\\"personal\\\"\\n            },\\n            {  \\n               \\\"address\\\":\\\"john.smith@hotmail.com\\\",\\n               \\\"address_type\\\":\\\"personal\\\"\\n            }\\n         ]\\n      }\\\" http://api.accurateappend.com/OSDI/V1/VerifyEmails\",\n      \"language\": \"curl\"\n    }\n  ]\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"warning\",\n  \"title\": \"Request Headers:\",\n  \"body\": \"When making a call to this API, the HTTP header \\\"content-type\\\" MUST be supplied with a value of \\\"application/json\\\". Failure to include this header will result in an HTTP 400 Bad Request response. Your choice of client library may automatically include this header. Please consult your documentation.\"\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Response Headers:\",\n  \"body\": \"The header \\\"accurateappend-transactionid\\\" will hold the unique value used to identify this request.\"\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Retrieve the validated email addresses\"\n}\n[/block]\nThe response will include a collection containing one or more OSDI *email_addresses *collection(s) with each collection attributed to a single status. \n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{  \\n   \\\"invalid\\\":[  \\n      {  \\n         \\\"address\\\":\\\"johnsmith@mail.com\\\",\\n         \\\"address_type\\\":\\\"personal\\\",\\n         \\\"primary\\\":true,\\n         \\\"status\\\":\\\"subscribed\\\"\\n      }\\n   ],\\n   \\\"valid\\\":[  \\n      {  \\n         \\\"address\\\":\\\"john.smith@gmail.com\\\",\\n         \\\"address_type\\\":\\\"personal\\\",\\n         \\\"primary\\\":false\\n      },\\n      {  \\n         \\\"address\\\":\\\"john.smith@hotmail.com\\\",\\n         \\\"address_type\\\":\\\"personal\\\",\\n         \\\"primary\\\":false\\n      }\\n   ]\\n}\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]\nEmail Validation Statuses\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"invalid\",\n    \"0-1\": \"Indicates mail should not be sent to address because email address is not accepting mail or email address appeared in suppression database.\",\n    \"h-0\": \"Status\",\n    \"h-1\": \"Description\",\n    \"1-0\": \"valid\",\n    \"2-0\": \"unknown\",\n    \"1-1\": \"Indicates email address is accepting mail.\",\n    \"2-1\": \"Indicates ISP was unable to be contacted and delivery status is unknown. Also means email address did not appear in suppression database.\"\n  },\n  \"cols\": 2,\n  \"rows\": 3\n}\n[/block]","excerpt":"Email verification allows you to verify your email addresses before you send to increase the success and deliverability of your email campaign. Once you've identified invalid emails from an existing list, you can run an append process to obtain the latest contact information for your supporters.","slug":"validate-email","type":"basic","title":"Validate Email"}

Validate Email

Email verification allows you to verify your email addresses before you send to increase the success and deliverability of your email campaign. Once you've identified invalid emails from an existing list, you can run an append process to obtain the latest contact information for your supporters.

[block:api-header] { "type": "basic", "title": "Features" } [/block] - Features a complete syntactical email validation engine that obeys current IETF standards, including RFC 1123, RFC 2821, RFC 2822, RFC 3490, RFC 3696, RFC 4291, RFC 5321, RFC 5322 and RFC 5336. - Detects temporary email addresses generated by certain free services on the Internet, collectively known as disposable email address providers. - Actively verifies delivery status of email addresses and flags known SPAM traps and inboxes that are simply out of space. [block:api-header] { "type": "basic", "title": "Getting Started" } [/block] API Endpoint is http://api.accurateappend.com/OSDI/V1/VerifyEmails [block:api-header] { "type": "basic", "title": "Tutorial: Making A Request" } [/block] [block:callout] { "type": "info", "title": "Note:", "body": "Keep your API key secret. Anyone with your API key will be able to access any data in your account. Therefore, the Accurate Append API is not suitable for front end-only implementations (such as a JavaScript and jQuery client) because this could expose your API key to others.\n\nThis API is a proprietary extension to the OSDI specification. It leverages the payload format of osdi:email_address structure to support verification." } [/block] [block:api-header] { "type": "basic", "title": "Call the operation with a OSDI Person object" } [/block] Validate Email will attempt to validate all emails contained in the email_addresses collection in the Person object passed in the request. [block:code] { "codes": [ { "code": "curl -i \n -H \"Accept: application/json\" -H \"Content-Type: application/json\" \n -H \"OSDI-API-Token: [Your API key]\" \n -X POST \n -d \"{ \n \"identifiers\":[ \n \"osdi_sample_system:d91b4b2e-ae0e-4cd3-9ed7-d0ec501b0bc3\",\n \"foreign_system:1\"\n ],\n \"given_name\":\"John\",\n \"family_name\":\"Smith\",\n \"additional_name\":\"Scott\",\n \"gender\":\"Male\",\n \"gender_identity\":\"Male\",\n \"birthdate\":{ \n \"month\":6,\n \"day\":2,\n \"year\":1973\n },\n \"ethnicities\":[ \n \"African American\"\n ],\n \"email_addresses\":[ \n { \n \"primary\":true,\n \"address\":\"johnsmith@mail.com\",\n \"address_type\":\"personal\",\n \"status\":\"subscribed\"\n },\n { \n \"address\":\"john.smith@gmail.com\",\n \"address_type\":\"personal\"\n },\n { \n \"address\":\"john.smith@hotmail.com\",\n \"address_type\":\"personal\"\n }\n ]\n }\" http://api.accurateappend.com/OSDI/V1/VerifyEmails", "language": "curl" } ] } [/block] [block:callout] { "type": "warning", "title": "Request Headers:", "body": "When making a call to this API, the HTTP header \"content-type\" MUST be supplied with a value of \"application/json\". Failure to include this header will result in an HTTP 400 Bad Request response. Your choice of client library may automatically include this header. Please consult your documentation." } [/block] [block:callout] { "type": "info", "title": "Response Headers:", "body": "The header \"accurateappend-transactionid\" will hold the unique value used to identify this request." } [/block] [block:api-header] { "type": "basic", "title": "Retrieve the validated email addresses" } [/block] The response will include a collection containing one or more OSDI *email_addresses *collection(s) with each collection attributed to a single status. [block:code] { "codes": [ { "code": "{ \n \"invalid\":[ \n { \n \"address\":\"johnsmith@mail.com\",\n \"address_type\":\"personal\",\n \"primary\":true,\n \"status\":\"subscribed\"\n }\n ],\n \"valid\":[ \n { \n \"address\":\"john.smith@gmail.com\",\n \"address_type\":\"personal\",\n \"primary\":false\n },\n { \n \"address\":\"john.smith@hotmail.com\",\n \"address_type\":\"personal\",\n \"primary\":false\n }\n ]\n}", "language": "json" } ] } [/block] Email Validation Statuses [block:parameters] { "data": { "0-0": "invalid", "0-1": "Indicates mail should not be sent to address because email address is not accepting mail or email address appeared in suppression database.", "h-0": "Status", "h-1": "Description", "1-0": "valid", "2-0": "unknown", "1-1": "Indicates email address is accepting mail.", "2-1": "Indicates ISP was unable to be contacted and delivery status is unknown. Also means email address did not appear in suppression database." }, "cols": 2, "rows": 3 } [/block]