{"_id":"561312efbe80130d00f188db","project":"55c80e130300460d00c91c1d","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"},"parentDoc":null,"__v":15,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-10-06T00:16:47.604Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":3,"body":"[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Getting Started\"\n}\n[/block]\nAPI Endpoint is http://api.accurateappend.com/OSDI/V1/AppendResidentialPhone\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Tutorial: Making A Request\"\n}\n[/block]\nAccurate Append Consumer Phone Append 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[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]\nThe presence of any elements in the \"phone_numbers\" 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/AppendResidentialPhone\",\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 a phone_numbers collection containing any newly appended phone numbers 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[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   \\\"phone_numbers\\\":[  \\n      {  \\n         \\\"number\\\":\\\"206111234\\\",\\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 or verify the phone numbers of your supporters and prospects using other contact information such as first name, last name or address information. Our databases hold both U.S. and Canadian landlines and U.S. mobile telephone numbers. \n\nAccurate Append maintains the most definitive, authoritative source of telephone numbers available in the phone append industry. Our phone databases are comprised of over 600 million landline and mobile phone numbers; helping you stay connected to your members, prospects, voters, donors, and more.","slug":"consumer-phone-append","type":"basic","title":"Consumer Phone Append"}

Consumer Phone Append

Reliably add or verify the phone numbers of your supporters and prospects using other contact information such as first name, last name or address information. Our databases hold both U.S. and Canadian landlines and U.S. mobile telephone numbers. Accurate Append maintains the most definitive, authoritative source of telephone numbers available in the phone append industry. Our phone databases are comprised of over 600 million landline and mobile phone numbers; helping you stay connected to your members, prospects, voters, donors, and more.

[block:api-header] { "type": "basic", "title": "Getting Started" } [/block] API Endpoint is http://api.accurateappend.com/OSDI/V1/AppendResidentialPhone [block:api-header] { "type": "basic", "title": "Tutorial: Making A Request" } [/block] Accurate Append Consumer Phone Append 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 [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] The presence of any elements in the "phone_numbers" 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/AppendResidentialPhone", "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 a phone_numbers collection containing any newly appended phone numbers 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. [block:code] { "codes": [ { "code": "{ \n \"identifiers\":[ \n \"osdi_sample_system:d91b4b2e-ae0e-4cd3-9ed7-d0ec501b0bc3\",\n \"foreign_system:1\"\n ],\n \"phone_numbers\":[ \n { \n \"number\":\"206111234\",\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]