{"_id":"569fd0345b981c2b00383dbc","user":"55f0757cda97fe2f007b4eba","project":"55c80e130300460d00c91c1d","parentDoc":null,"__v":17,"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"},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-01-20T18:21:40.166Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":4,"body":"[block:callout]\n{\n  \"type\": \"warning\",\n  \"body\": \"This section documents pre-release information about this API and is subject to change.\"\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Getting Started\"\n}\n[/block]\nAPI Endpoint is http://api.accurateappend.com/OSDI/V1/PersonSignupHelper\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Tutorial: Making A Request\"\n}\n[/block]\nAccurate Append Consumer Person Signup Helper implements the standardized OSDI Person Signup Helper person field only. Any additional fields are not operated on and are ignored. For more information about this operation please see http://opensupporter.github.io/osdi-docs/person_signup.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 Person Signup Helper implementation working a fixed set of validation and append behaviors and is by design expected to be part of a person create/merge process for a 3rd party system (or client if performing pre-submit appends to the 3rd party system). Specific append and verification products on existing data will usually be better served by our other endpoints, especially with existing Person records.\n\n\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Operation\",\n    \"h-1\": \"Description\",\n    \"0-0\": \"Address Standardization\",\n    \"0-1\": \"For each address input in the \\\"postal_addresses\\\" CASS standardization is performed provided the address input is US or Canadian. Defined as \\\"country\\\" attribute is empty or missing OR matching the countries ISO 3166-1 alpha-2​ code values in invariant case match. Unable to be standardized inputs will be left as is.\",\n    \"1-0\": \"Email Address Verification\",\n    \"1-1\": \"For each email input in the \\\"email_addresses​\\\" we will perform real-time email address verification. Any confirmed undeliverable address will have the \\\"status\\\" attribute set to the \\\"bouncing\\\" enumeration value.\",\n    \"2-1\": \"For each phone input in the \\\"phone_numbers​\\\" we will perform connection status verification on elements with EXACTLY the \\\"Home\\\" value for the \\\"number_type​\\\" attribute AND US and CA phones only. Defined as \\\"country\\\" attribute is empty or missing OR matching the countries ISO 3166-1 alpha-2​ code values in invariant case match. Known disconnected values will be SCRUBBED from the response.\",\n    \"2-0\": \"Phone Connection Status\",\n    \"3-0\": \"Residential Phone Append\",\n    \"3-1\": \"If the supplied Person resource is lacking any input in the \\\"phone_numbers\\\" element, a Residential Phone Append will be performed. requires a first and last name and a US or Canadian address. Defined as \\\"country\\\" attribute is empty or missing OR matching the countries ISO 3166-1 alpha-2​ code values in invariant case match.\"\n  },\n  \"cols\": 2,\n  \"rows\": 4\n}\n[/block]\n\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       \\\"person\\\" :\\n       {\\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}\\n}\\\" http://api.accurateappend.com/OSDI/V1/PersonSignupHelper/{License Key}\",\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 the input with any append and verified data applied. It is important to note that the response will contain BOTH appended information and the full original input representation. This response MUST be captured by the client; No data is stored on our system.\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       \\\"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}\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]","excerpt":"Integrate standardized append and data verification into your OSDI signup process.  Standardize your US and Canadian addresses, verify email address deliverability, scrub disconnected phones, and append missing residential phone connectivity helping you stay connected to your members, prospects, voters, donors, and more.","slug":"person-signup-helper","type":"basic","title":"Person Signup Helper"}

Person Signup Helper

Integrate standardized append and data verification into your OSDI signup process. Standardize your US and Canadian addresses, verify email address deliverability, scrub disconnected phones, and append missing residential phone connectivity helping you stay connected to your members, prospects, voters, donors, and more.

[block:callout] { "type": "warning", "body": "This section documents pre-release information about this API and is subject to change." } [/block] [block:api-header] { "type": "basic", "title": "Getting Started" } [/block] API Endpoint is http://api.accurateappend.com/OSDI/V1/PersonSignupHelper [block:api-header] { "type": "basic", "title": "Tutorial: Making A Request" } [/block] Accurate Append Consumer Person Signup Helper implements the standardized OSDI Person Signup Helper person field only. Any additional fields are not operated on and are ignored. For more information about this operation please see http://opensupporter.github.io/osdi-docs/person_signup.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 Person Signup Helper implementation working a fixed set of validation and append behaviors and is by design expected to be part of a person create/merge process for a 3rd party system (or client if performing pre-submit appends to the 3rd party system). Specific append and verification products on existing data will usually be better served by our other endpoints, especially with existing Person records. [block:parameters] { "data": { "h-0": "Operation", "h-1": "Description", "0-0": "Address Standardization", "0-1": "For each address input in the \"postal_addresses\" CASS standardization is performed provided the address input is US or Canadian. Defined as \"country\" attribute is empty or missing OR matching the countries ISO 3166-1 alpha-2​ code values in invariant case match. Unable to be standardized inputs will be left as is.", "1-0": "Email Address Verification", "1-1": "For each email input in the \"email_addresses​\" we will perform real-time email address verification. Any confirmed undeliverable address will have the \"status\" attribute set to the \"bouncing\" enumeration value.", "2-1": "For each phone input in the \"phone_numbers​\" we will perform connection status verification on elements with EXACTLY the \"Home\" value for the \"number_type​\" attribute AND US and CA phones only. Defined as \"country\" attribute is empty or missing OR matching the countries ISO 3166-1 alpha-2​ code values in invariant case match. Known disconnected values will be SCRUBBED from the response.", "2-0": "Phone Connection Status", "3-0": "Residential Phone Append", "3-1": "If the supplied Person resource is lacking any input in the \"phone_numbers\" element, a Residential Phone Append will be performed. requires a first and last name and a US or Canadian address. Defined as \"country\" attribute is empty or missing OR matching the countries ISO 3166-1 alpha-2​ code values in invariant case match." }, "cols": 2, "rows": 4 } [/block] [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 \"person\" :\n {\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}\n}\" http://api.accurateappend.com/OSDI/V1/PersonSignupHelper/{License Key}", "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 the input with any append and verified data applied. It is important to note that the response will contain BOTH appended information and the full original input representation. This response MUST be captured by the client; No data is stored on our system. [block:code] { "codes": [ { "code": "{\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}", "language": "json" } ] } [/block]