{"_id":"561312db41a9ec0d00a3fdfe","parentDoc":null,"user":"55c80d9f0300460d00c91c1a","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"},"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"},"__v":27,"project":"55c80e130300460d00c91c1d","updates":["5616c2f8c8c5e70d00a8a1ad"],"next":{"pages":[],"description":""},"createdAt":"2015-10-06T00:16:27.176Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"settings":"","results":{"codes":[]},"auth":"required","params":[],"url":""},"isReference":false,"order":2,"body":"[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Getting Started\"\n}\n[/block]\nAPI Endpoint is http://api.accurateappend.com/OSDI/V1/AppendEmail\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}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Call the operation with a OSDI Person object\"\n}\n[/block]\nAccurate Append Verified Email Append API implements the standardized OSDI Person resource creation operation. This simulates the \"creation\" of a new Person resource against our API infrastructure and is interpreted as a unique append request. For more information about this operation please see http://opensupporter.github.io/osdi-docs/people.html#scenario-creating-a-new-person-post\n\nThe presence of any elements in the \"email_addresses\" array supplied with Person payload will be considered preexisting and the append operation will automatically exclude them when finding additional matches. This input is not required.\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\\\":1,\\n          \\\"day\\\":1,\\n          \\\"year\\\":1960\\n       },\\n       \\\"ethnicities\\\":[  \\n          \\\"African American \\n    \\\"\\n       ],\\n       \\\"postal_addresses\\\":[  \\n          {  \\n             \\\"primary\\\":true,\\n             \\\"address_lines\\\":[  \\n                \\\"1234 Main Ave S\\\"\\n             ],\\n             \\\"locality\\\":\\\"Seattle\\\",\\n             \\\"region\\\":\\\"WA\\\",\\n             \\\"postal_code\\\":\\\"98118\\\"\\n          }\\n   ]\\n}\\\" http://api.accurateappend.com/OSDI/V1/AppendEmail\",\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 newly populated Person object\"\n}\n[/block]\nThe Person object in the response will contain an email_addresses collection containing any newly appended email addresses with the \"primary\" attribute set to *false*. It is important to note that the response will only contain appended information and not the full original input representation requiring merging by the client. The entire set original \"identifiers\" array values will always be returned regardless of any appended matches.\n\nAll email addresses included in the response are verified as deliverable in real-time prior to being returned.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{  \\n   \\\"identifiers\\\":[  \\n      \\\"osdi_sample_system:d91b4b2e-ae0e-4cd3-9ed7-d0ec501b0bc3\\\",\\n      \\\"foreign_system:1\\\"\\n   ],\\n   \\\"email_addresses\\\":[  \\n      {  \\n         \\\"address\\\":\\\"SMITH.JOHN:::at:::HOTMAIL.COM\\\",\\n         \\\"primary\\\":false\\n      }\\n   ]\\n}\",\n      \"language\": \"json\"\n    }\n  ]\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]","excerpt":"Reliably add email addresses to your consumer lists by searching our database using other contact information such as first name, last name, city, state and physical address. Our email database is comprised of more than 900 million email addresses. Any email that Accurate Append appends or verifies is verified as deliverable in real-time using the latest advancements in SMTP verification.","slug":"email-append","type":"basic","title":"Email Append"}

Email Append

Reliably add email addresses to your consumer lists by searching our database using other contact information such as first name, last name, city, state and physical address. Our email database is comprised of more than 900 million email addresses. Any email that Accurate Append appends or verifies is verified as deliverable in real-time using the latest advancements in SMTP verification.

[block:api-header] { "type": "basic", "title": "Getting Started" } [/block] API Endpoint is http://api.accurateappend.com/OSDI/V1/AppendEmail [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." } [/block] [block:api-header] { "type": "basic", "title": "Call the operation with a OSDI Person object" } [/block] Accurate Append Verified Email Append API implements the standardized OSDI Person resource creation operation. This simulates the "creation" of a new Person resource against our API infrastructure and is interpreted as a unique append request. For more information about this operation please see http://opensupporter.github.io/osdi-docs/people.html#scenario-creating-a-new-person-post The presence of any elements in the "email_addresses" array supplied with Person payload will be considered preexisting and the append operation will automatically exclude them when finding additional matches. This input is not required. [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\":1,\n \"day\":1,\n \"year\":1960\n },\n \"ethnicities\":[ \n \"African American \n \"\n ],\n \"postal_addresses\":[ \n { \n \"primary\":true,\n \"address_lines\":[ \n \"1234 Main Ave S\"\n ],\n \"locality\":\"Seattle\",\n \"region\":\"WA\",\n \"postal_code\":\"98118\"\n }\n ]\n}\" http://api.accurateappend.com/OSDI/V1/AppendEmail", "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 newly populated Person object" } [/block] The Person object in the response will contain an email_addresses collection containing any newly appended email addresses with the "primary" attribute set to *false*. It is important to note that the response will only contain appended information and not the full original input representation requiring merging by the client. The entire set original "identifiers" array values will always be returned regardless of any appended matches. All email addresses included in the response are verified as deliverable in real-time prior to being returned. [block:code] { "codes": [ { "code": "{ \n \"identifiers\":[ \n \"osdi_sample_system:d91b4b2e-ae0e-4cd3-9ed7-d0ec501b0bc3\",\n \"foreign_system:1\"\n ],\n \"email_addresses\":[ \n { \n \"address\":\"SMITH.JOHN@HOTMAIL.COM\",\n \"primary\":false\n }\n ]\n}", "language": "json" } ] } [/block] [block:callout] { "type": "info", "title": "Response Headers:", "body": "The header \"accurateappend-transactionid\" will hold the unique value used to identify this request." } [/block]