{"_id":"59de6011debd1200240f6929","version":{"_id":"59de6011debd1200240f68ee","__v":3,"project":"59de6011debd1200240f68ec","createdAt":"2016-06-20T18:15:42.514Z","releaseDate":"2016-06-20T18:15:42.514Z","categories":["59de6011debd1200240f68fb","59de6011debd1200240f68fa","59de6011debd1200240f68fc","59de6011debd1200240f68f8","59de6011debd1200240f68f7","59de6011debd1200240f68f9","59de6011debd1200240f68fd","59de6011debd1200240f68fe","59de6011debd1200240f68ff","5a8bfb99f4146e00449cec47","5a8bfcf2e86f530012159bb2","5cd4c29c6ea1040056ec0f55"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"2.0.0","version":"2.0"},"__v":8,"parentDoc":null,"project":"59de6011debd1200240f68ec","category":{"_id":"59de6011debd1200240f68fa","project":"59de6011debd1200240f68ec","version":"59de6011debd1200240f68ee","__v":0,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2016-02-19T01:01:16.044Z","from_sync":false,"order":2,"slug":"endpoints","title":"Applicant Management"},"user":"547504ed59fade080004cb8b","githubsync":"","metadata":{"title":"","description":"","image":[]},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-02-19T01:29:13.024Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"settings":"","examples":{"codes":[{"language":"curl","code":"curl -X POST -H 'Content-Type: application/json' -d '{\"name\":\"John\",\"email\":\"john:::at:::gmail.com\",\"phone_number\":\"5034834844\",\"api_token\":\"secret-api-token\"}' 'https://api.fountain.com/v2/applicants'"}]},"method":"post","results":{"codes":[{"code":"{\n  \"id\": \"e8e4edc5-096c-47ea-b682-f77c6c4462dd\",\n  \"email\": \"john@gmail.com\",\n  \"name\": \"John\",\n  \"phone_number\": \"5034834844\",\n  \"data\": {\n    \"any_other_parameter\": \"Toyota Prius\",\n    }\n  },\n  \"portal_url\": \"/portal/test_account/result/db2ab7ffd0726a7f\",\n  \"created_at\": \"2015-06-05T05:53:46.749-07:00\",\n  \"funnel\": {\n    \"id\": \"de79f80f-43da-4e4c-87d6-9bf714753535\",\n    \"title\": \"Corporate Security Facilitator\",\n    \"custom_id\": \"3d67750a-dcf4-4ada-a3e4-ee44661949fc\"\n  },\n  \"stage\": {\n    \"id\": \"4d09fca4-6599-4418-b385-6cf173e01b66\",\n    \"title\": \"Approved\"\n  },\n  \"background_checks\": [\n    {\n      \"title\": \"Driver license check\",\n      \"status\": \"pending\",\n      \"vendor\": \"checkr\",\n      \"candidate_id\": \"e44aa283528e6fde7d542194\",\n      \"report_id\": \"4722c07dd9a10c3985ae432a\"\n    }\n  ],\n  \"document_signatures\": [\n    {\n      \"vendor\": \"hellosign\",\n      \"signature_id\": \"123dfdsf\",\n      \"status\": \"signed\"\n    }\n  ],\n  \"labels\": [\n    {\n      \"title\": \"Label-0\",\n      \"completed\": true\n    }\n  ]\n}","name":"","status":200,"language":"json"},{"status":401,"language":"json","code":"{\n  \"message\": \"Authentication is required\"\n}","name":""}]},"auth":"required","params":[{"_id":"56c66fe970e7660d004a8980","ref":"","in":"body","required":true,"desc":"Input a full name","default":"Kelsey Smith","type":"string","name":"name"},{"_id":"56c66fe970e7660d004a897f","ref":"","in":"body","required":true,"desc":"Email Address","default":"kelsey@gmail.com","type":"string","name":"email"},{"_id":"56c66fe970e7660d004a897e","ref":"","in":"body","required":true,"desc":"Phone Number (does not have to be USA)","default":"5034834844","type":"string","name":"phone_number"},{"_id":"56c66fe970e7660d004a897d","ref":"","in":"body","required":false,"desc":"Add as many additional parameters as you wish","default":"Toyota Prius","type":"string","name":"data[any_other_params]"},{"_id":"57756e13fecd260e00d86d94","ref":"","in":"body","required":false,"desc":"Add any secure parameters from the list below","default":"American","type":"string","name":"secure_data[any_secure_params]"},{"_id":"56ca916f6b58fb0b00c6d30f","ref":"","in":"body","required":false,"desc":"Required if api_token is not passed in header","default":"secret-api-token","type":"string","name":"api_token"},{"_id":"58d975eda176ae2500e165fb","ref":"","in":"body","required":false,"desc":"Optional parameter to create an applicant under a certain opening","default":"49dbf2f3-057f-44b4-a638-8fac5aac2ad","type":"string","name":"funnel_id"},{"_id":"59ea13eba90dc1002e7c5be3","ref":"","in":"body","required":false,"desc":"Optional parameter to create an applicant under a certain stage","default":"550e8400-e29b-41d4-a716-446655440000","type":"string","name":"stage_id"},{"_id":"5a6224ebda07540012e8de20","ref":"","in":"body","required":false,"desc":"Set `true` if you want to skip automated actions when advancing the applicant","default":"false","type":"boolean","name":"skip_automated_actions"}],"url":"/applicants"},"isReference":false,"order":2,"body":"# Create an applicant\n\nTo create an applicant, just pass some required attributes, and you are ready to go.\n\n- Required attributes: `name`, `email`, `phone_number`;\n- `email` must be a valid e-mail address;\n- `phone_number` must be a string;\n- All keys must be at the root level.\n- Use the `funnel_id` parameter to indicate which opening should the applicant go to. To do that, supply a opening unique ID (such as `49dbf2f3-057f-44b4-a638-8fac5aac2adf`, for example) from the List openings method.\n\nYou can also add \nOnly these specific types of secure data are supported. They can be sent to Fountain through a standard POST request if sent as as 'secure_data[ethnicity]'.\n\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Secure Fields\",\n  \"body\": \"You can also add secure fields by passing in a secure_data array along with the standard data array. These fields are encrypted in our system, so you should use them for personally identifiable and sensitive information like SSN, driver's license numbers, etc. Supported fields include:\\n- gender\\n- ethnicity\\n- citizenship\\n- can_work_in_us\\n- religious_preference\\n- income_salary\\n- income_income_tax_dollar_amount\\n- income_ss_tax\\n- income_medicare_tax\\n- income_taxpayer_identification_number\\n- driver_license_number\\n- driver_license_expiration_date\\n- driver_license_state\\n- ssn\\n- national_identification_number\\n- insurance_type\\n- insurance_benefactor_first_name\\n- insurance_benefactor_middle_name\\n- insurance_benefactor_last_name\\n- insurance_member_id\\n- insurance_company_group_id\\n- insurance_company_of_issue\\n- insurance_country_of_issue\\n- insurance_city_of_issue\\n- insurance_issue_date\\n- insurance_expiration_date\\n- bank_name\\n- bank_routing_number\\n- bank_account_number\\n- passport_number\\n- passport_country_of_issue\\n- passport_city_of_issue\\n- passport_issue_date\\n- passport_expiration_date\\n- vehicle_make\\n- vehicle_model\\n- vehicle_year\\n- vehicle_registration_plate_number\\n- vehicle_vin_number\"\n}\n[/block]\n## Response Schema\n\n[block:html]\n{\n  \"html\": \"<ul><li>additionalProperties: false</li><li>    <span id=\\\"id-0-2735262238844431308\\\">\\n      <a href=\\\"#id-0-2735262238844431308\\\" class=\\\"anchor\\\">\\n        <tt>id</tt>\\n      </a>\\n    </span>\\n<div class=\\\"schema\\\"><ul><li>Required: no</li><li>Type: string</li><li>Example: <tt>\\\"e8e4edc5-096c-47ea-b682-f77c6c4462dd\\\"</tt></li></ul></div></li><li>    <span id=\\\"email-0-1017510195829780304\\\">\\n      <a href=\\\"#email-0-1017510195829780304\\\" class=\\\"anchor\\\">\\n        <tt>email</tt>\\n      </a>\\n    </span>\\n<div class=\\\"schema\\\"><ul><li>Required: no</li><li>Type: string</li><li>Example: <tt>\\\"john@gmail.com\\\"</tt></li></ul></div></li><li>    <span id=\\\"name-0-1567369598735379560\\\">\\n      <a href=\\\"#name-0-1567369598735379560\\\" class=\\\"anchor\\\">\\n        <tt>name</tt>\\n      </a>\\n    </span>\\n<div class=\\\"schema\\\"><ul><li>Required: no</li><li>Type: string</li><li>Example: <tt>\\\"John\\\"</tt></li></ul></div></li><li>    <span id=\\\"phone_number-0--3140272604887477128\\\">\\n      <a href=\\\"#phone_number-0--3140272604887477128\\\" class=\\\"anchor\\\">\\n        <tt>phone_number</tt>\\n      </a>\\n    </span>\\n<div class=\\\"schema\\\"><ul><li>Required: no</li><li>Type: string</li><li>Example: <tt>\\\"5034834844\\\"</tt></li></ul></div></li><li>    <span id=\\\"data-0-331081581558582272\\\">\\n      <a href=\\\"#data-0-331081581558582272\\\" class=\\\"anchor\\\">\\n        <tt>data</tt>\\n      </a>\\n    </span>\\n<div class=\\\"schema\\\"><ul><li>Required: no</li><li>additionalProperties: false</li><li>    <span id=\\\"any-1-472918328424028404\\\">\\n      <a href=\\\"#any-1-472918328424028404\\\" class=\\\"anchor\\\">\\n        <tt>any</tt>\\n      </a>\\n    </span>\\n<div class=\\\"schema\\\"><ul><li>Required: no</li><li>Type: string</li><li>Example: <tt>\\\"other\\\"</tt></li></ul></div></li><li>    <span id=\\\"keys-1--3546173800584855040\\\">\\n      <a href=\\\"#keys-1--3546173800584855040\\\" class=\\\"anchor\\\">\\n        <tt>keys</tt>\\n      </a>\\n    </span>\\n<div class=\\\"schema\\\"><ul><li>Required: no</li><li>Type: string</li><li>Example: <tt>\\\"that you might want\\\"</tt></li></ul></div></li><li>    <span id=\\\"address-1--3398658676785546232\\\">\\n      <a href=\\\"#address-1--3398658676785546232\\\" class=\\\"anchor\\\">\\n        <tt>address</tt>\\n      </a>\\n    </span>\\n<div class=\\\"schema\\\"><ul><li>Required: no</li><li>additionalProperties: false</li><li>    <span id=\\\"street-2--684598738958598224\\\">\\n      <a href=\\\"#street-2--684598738958598224\\\" class=\\\"anchor\\\">\\n        <tt>street</tt>\\n      </a>\\n    </span>\\n<div class=\\\"schema\\\"><ul><li>Required: no</li><li>Type: string</li><li>Example: <tt>\\\"123 main st\\\"</tt></li></ul></div></li><li>    <span id=\\\"city-2-2170082088190540148\\\">\\n      <a href=\\\"#city-2-2170082088190540148\\\" class=\\\"anchor\\\">\\n        <tt>city</tt>\\n      </a>\\n    </span>\\n<div class=\\\"schema\\\"><ul><li>Required: no</li><li>Type: string</li><li>Example: <tt>\\\"San Francisco, CA\\\"</tt></li></ul></div></li></ul></div></li></ul></div></li><li>    <span id=\\\"created_at-0--3863856295782724640\\\">\\n      <a href=\\\"#created_at-0--3863856295782724640\\\" class=\\\"anchor\\\">\\n        <tt>created_at</tt>\\n      </a>\\n    </span>\\n<div class=\\\"schema\\\"><ul><li>Required: no</li><li>Type: string</li><li>Format: date-time</li><li>Example: <tt>\\\"2015-06-05T05:53:46.749-07:00\\\"</tt></li></ul></div></li><li>    <span id=\\\"funnel-0--535556761852237600\\\">\\n      <a href=\\\"#funnel-0--535556761852237600\\\" class=\\\"anchor\\\">\\n        <tt>funnel</tt>\\n      </a>\\n    </span>\\n<div class=\\\"schema\\\"><ul><li>Required: no</li><li>additionalProperties: false</li><li>    <span id=\\\"id-1-979689635089775780\\\">\\n      <a href=\\\"#id-1-979689635089775780\\\" class=\\\"anchor\\\">\\n        <tt>id</tt>\\n      </a>\\n    </span>\\n<div class=\\\"schema\\\"><ul><li>Required: no</li><li>Type: string</li><li>Example: <tt>\\\"de79f80f-43da-4e4c-87d6-9bf714753535\\\"</tt></li></ul></div></li><li>    <span id=\\\"title-1-3996638107768797980\\\">\\n      <a href=\\\"#title-1-3996638107768797980\\\" class=\\\"anchor\\\">\\n        <tt>title</tt>\\n      </a>\\n    </span>\\n<div class=\\\"schema\\\"><ul><li>Required: no</li><li>Type: string</li><li>Example: <tt>\\\"Corporate Security Facilitator\\\"</tt></li></ul></div></li></ul></div></li><li>    <span id=\\\"stage-0--617248999000103264\\\">\\n      <a href=\\\"#stage-0--617248999000103264\\\" class=\\\"anchor\\\">\\n        <tt>stage</tt>\\n      </a>\\n    </span>\\n<div class=\\\"schema\\\"><ul><li>Required: no</li><li>additionalProperties: false</li><li>    <span id=\\\"id-1-4030627740244284332\\\">\\n      <a href=\\\"#id-1-4030627740244284332\\\" class=\\\"anchor\\\">\\n        <tt>id</tt>\\n      </a>\\n    </span>\\n<div class=\\\"schema\\\"><ul><li>Required: no</li><li>Type: string</li><li>Example: <tt>\\\"4d09fca4-6599-4418-b385-6cf173e01b66\\\"</tt></li></ul></div></li><li>    <span id=\\\"title-1--656844964611395908\\\">\\n      <a href=\\\"#title-1--656844964611395908\\\" class=\\\"anchor\\\">\\n        <tt>title</tt>\\n      </a>\\n    </span>\\n<div class=\\\"schema\\\"><ul><li>Required: no</li><li>Type: string</li><li>Example: <tt>\\\"Approved\\\"</tt></li></ul></div></li></ul></div></li><li>    <span id=\\\"background_checks-0-1093283633238088424\\\">\\n      <a href=\\\"#background_checks-0-1093283633238088424\\\" class=\\\"anchor\\\">\\n        <tt>background_checks</tt>\\n      </a>\\n    </span>\\n<div class=\\\"schema\\\"><ul><li>Required: no</li><li>Type: array</li><li>Items<div class=\\\"schema\\\"><ul><li>Required: no</li><li>additionalProperties: false</li><li>    <span id=\\\"title-2--3490851928509029076\\\">\\n      <a href=\\\"#title-2--3490851928509029076\\\" class=\\\"anchor\\\">\\n        <tt>title</tt>\\n      </a>\\n    </span>\\n<div class=\\\"schema\\\"><ul><li>Required: no</li><li>Type: string</li><li>Example: <tt>\\\"Driver license check\\\"</tt></li></ul></div></li><li>    <span id=\\\"status-2--1378084316743439420\\\">\\n      <a href=\\\"#status-2--1378084316743439420\\\" class=\\\"anchor\\\">\\n        <tt>status</tt>\\n      </a>\\n    </span>\\n<div class=\\\"schema\\\"><ul><li>Required: no</li><li>Type: string</li><li>Example: <tt>\\\"pending\\\"</tt></li></ul></div></li><li>    <span id=\\\"vendor-2--1116928499757215828\\\">\\n      <a href=\\\"#vendor-2--1116928499757215828\\\" class=\\\"anchor\\\">\\n        <tt>vendor</tt>\\n      </a>\\n    </span>\\n<div class=\\\"schema\\\"><ul><li>Required: no</li><li>Type: string</li><li>Example: <tt>\\\"checkr\\\"</tt></li></ul></div></li><li>    <span id=\\\"candidate_id-2--766588445614545596\\\">\\n      <a href=\\\"#candidate_id-2--766588445614545596\\\" class=\\\"anchor\\\">\\n        <tt>candidate_id</tt>\\n      </a>\\n    </span>\\n<div class=\\\"schema\\\"><ul><li>Required: no</li><li>Type: string</li><li>Example: <tt>\\\"e44aa283528e6fde7d542194\\\"</tt></li></ul></div></li><li>    <span id=\\\"report_id-2-2224626826341256068\\\">\\n      <a href=\\\"#report_id-2-2224626826341256068\\\" class=\\\"anchor\\\">\\n        <tt>report_id</tt>\\n      </a>\\n    </span>\\n<div class=\\\"schema\\\"><ul><li>Required: no</li><li>Type: string</li><li>Example: <tt>\\\"4722c07dd9a10c3985ae432a\\\"</tt></li></ul></div></li></ul></div></li></ul></div></li><li>    <span id=\\\"document_signatures-0-282550241065113700\\\">\\n      <a href=\\\"#document_signatures-0-282550241065113700\\\" class=\\\"anchor\\\">\\n        <tt>document_signatures</tt>\\n      </a>\\n    </span>\\n<div class=\\\"schema\\\"><ul><li>Required: no</li><li>Type: array</li><li>Items<div class=\\\"schema\\\"><ul><li>Required: no</li><li>additionalProperties: false</li><li>    <span id=\\\"vendor-2--3080330108168517492\\\">\\n      <a href=\\\"#vendor-2--3080330108168517492\\\" class=\\\"anchor\\\">\\n        <tt>vendor</tt>\\n      </a>\\n    </span>\\n<div class=\\\"schema\\\"><ul><li>Required: no</li><li>Type: string</li><li>Example: <tt>\\\"hellosign\\\"</tt></li></ul></div></li><li>    <span id=\\\"signature_id-2-498352775983210796\\\">\\n      <a href=\\\"#signature_id-2-498352775983210796\\\" class=\\\"anchor\\\">\\n        <tt>signature_id</tt>\\n      </a>\\n    </span>\\n<div class=\\\"schema\\\">Vendor-specific signature ID<ul><li>Required: no</li><li>Type: string</li><li>Example: <tt>\\\"123dfdsf\\\"</tt></li></ul></div></li><li>    <span id=\\\"status-2--2367106194852174228\\\">\\n      <a href=\\\"#status-2--2367106194852174228\\\" class=\\\"anchor\\\">\\n        <tt>status</tt>\\n      </a>\\n    </span>\\n<div class=\\\"schema\\\">Status of this request (opened, signed or admin_reviewed)<ul><li>Required: no</li><li>Type: string</li><li>Example: <tt>\\\"signed\\\"</tt></li></ul></div></li></ul></div></li></ul></div></li><li>    <span id=\\\"labels-0--2248149293993269276\\\">\\n      <a href=\\\"#labels-0--2248149293993269276\\\" class=\\\"anchor\\\">\\n        <tt>labels</tt>\\n      </a>\\n    </span>\\n<div class=\\\"schema\\\"><ul><li>Required: no</li><li>Type: array</li><li>Items<div class=\\\"schema\\\"><ul><li>Required: no</li><li>additionalProperties: false</li><li>    <span id=\\\"title-2--1766485754682808260\\\">\\n      <a href=\\\"#title-2--1766485754682808260\\\" class=\\\"anchor\\\">\\n        <tt>title</tt>\\n      </a>\\n    </span>\\n<div class=\\\"schema\\\"><ul><li>Required: no</li><li>Type: string</li><li>Example: <tt>\\\"Label-0\\\"</tt></li></ul></div></li><li>    <span id=\\\"completed-2--103234745214925392\\\">\\n      <a href=\\\"#completed-2--103234745214925392\\\" class=\\\"anchor\\\">\\n        <tt>completed</tt>\\n      </a>\\n    </span>\\n<div class=\\\"schema\\\"><ul><li>Required: no</li><li>Type: boolean</li><li>Example: <tt>false</tt></li></ul></div></li></ul></div></li></ul></div></li></ul>\"\n}\n[/block]","excerpt":"","slug":"post-apiv2applicants","type":"endpoint","title":"Create an Applicant"}

postCreate an Applicant


Definition

{{ api_url }}{{ page_api_url }}

Parameters

Body Params

name:
required
stringKelsey Smith
Input a full name
email:
required
stringkelsey@gmail.com
Email Address
phone_number:
required
string5034834844
Phone Number (does not have to be USA)
data[any_other_params]:
stringToyota Prius
Add as many additional parameters as you wish
secure_data[any_secure_params]:
stringAmerican
Add any secure parameters from the list below
api_token:
stringsecret-api-token
Required if api_token is not passed in header
funnel_id:
string49dbf2f3-057f-44b4-a638-8fac5aac2ad
Optional parameter to create an applicant under a certain opening
stage_id:
string550e8400-e29b-41d4-a716-446655440000
Optional parameter to create an applicant under a certain stage
skip_automated_actions:
booleanfalse
Set `true` if you want to skip automated actions when advancing the applicant

Examples


Result Format


Documentation

# Create an applicant To create an applicant, just pass some required attributes, and you are ready to go. - Required attributes: `name`, `email`, `phone_number`; - `email` must be a valid e-mail address; - `phone_number` must be a string; - All keys must be at the root level. - Use the `funnel_id` parameter to indicate which opening should the applicant go to. To do that, supply a opening unique ID (such as `49dbf2f3-057f-44b4-a638-8fac5aac2adf`, for example) from the List openings method. You can also add Only these specific types of secure data are supported. They can be sent to Fountain through a standard POST request if sent as as 'secure_data[ethnicity]'. [block:callout] { "type": "info", "title": "Secure Fields", "body": "You can also add secure fields by passing in a secure_data array along with the standard data array. These fields are encrypted in our system, so you should use them for personally identifiable and sensitive information like SSN, driver's license numbers, etc. Supported fields include:\n- gender\n- ethnicity\n- citizenship\n- can_work_in_us\n- religious_preference\n- income_salary\n- income_income_tax_dollar_amount\n- income_ss_tax\n- income_medicare_tax\n- income_taxpayer_identification_number\n- driver_license_number\n- driver_license_expiration_date\n- driver_license_state\n- ssn\n- national_identification_number\n- insurance_type\n- insurance_benefactor_first_name\n- insurance_benefactor_middle_name\n- insurance_benefactor_last_name\n- insurance_member_id\n- insurance_company_group_id\n- insurance_company_of_issue\n- insurance_country_of_issue\n- insurance_city_of_issue\n- insurance_issue_date\n- insurance_expiration_date\n- bank_name\n- bank_routing_number\n- bank_account_number\n- passport_number\n- passport_country_of_issue\n- passport_city_of_issue\n- passport_issue_date\n- passport_expiration_date\n- vehicle_make\n- vehicle_model\n- vehicle_year\n- vehicle_registration_plate_number\n- vehicle_vin_number" } [/block] ## Response Schema [block:html] { "html": "<ul><li>additionalProperties: false</li><li> <span id=\"id-0-2735262238844431308\">\n <a href=\"#id-0-2735262238844431308\" class=\"anchor\">\n <tt>id</tt>\n </a>\n </span>\n<div class=\"schema\"><ul><li>Required: no</li><li>Type: string</li><li>Example: <tt>\"e8e4edc5-096c-47ea-b682-f77c6c4462dd\"</tt></li></ul></div></li><li> <span id=\"email-0-1017510195829780304\">\n <a href=\"#email-0-1017510195829780304\" class=\"anchor\">\n <tt>email</tt>\n </a>\n </span>\n<div class=\"schema\"><ul><li>Required: no</li><li>Type: string</li><li>Example: <tt>\"john@gmail.com\"</tt></li></ul></div></li><li> <span id=\"name-0-1567369598735379560\">\n <a href=\"#name-0-1567369598735379560\" class=\"anchor\">\n <tt>name</tt>\n </a>\n </span>\n<div class=\"schema\"><ul><li>Required: no</li><li>Type: string</li><li>Example: <tt>\"John\"</tt></li></ul></div></li><li> <span id=\"phone_number-0--3140272604887477128\">\n <a href=\"#phone_number-0--3140272604887477128\" class=\"anchor\">\n <tt>phone_number</tt>\n </a>\n </span>\n<div class=\"schema\"><ul><li>Required: no</li><li>Type: string</li><li>Example: <tt>\"5034834844\"</tt></li></ul></div></li><li> <span id=\"data-0-331081581558582272\">\n <a href=\"#data-0-331081581558582272\" class=\"anchor\">\n <tt>data</tt>\n </a>\n </span>\n<div class=\"schema\"><ul><li>Required: no</li><li>additionalProperties: false</li><li> <span id=\"any-1-472918328424028404\">\n <a href=\"#any-1-472918328424028404\" class=\"anchor\">\n <tt>any</tt>\n </a>\n </span>\n<div class=\"schema\"><ul><li>Required: no</li><li>Type: string</li><li>Example: <tt>\"other\"</tt></li></ul></div></li><li> <span id=\"keys-1--3546173800584855040\">\n <a href=\"#keys-1--3546173800584855040\" class=\"anchor\">\n <tt>keys</tt>\n </a>\n </span>\n<div class=\"schema\"><ul><li>Required: no</li><li>Type: string</li><li>Example: <tt>\"that you might want\"</tt></li></ul></div></li><li> <span id=\"address-1--3398658676785546232\">\n <a href=\"#address-1--3398658676785546232\" class=\"anchor\">\n <tt>address</tt>\n </a>\n </span>\n<div class=\"schema\"><ul><li>Required: no</li><li>additionalProperties: false</li><li> <span id=\"street-2--684598738958598224\">\n <a href=\"#street-2--684598738958598224\" class=\"anchor\">\n <tt>street</tt>\n </a>\n </span>\n<div class=\"schema\"><ul><li>Required: no</li><li>Type: string</li><li>Example: <tt>\"123 main st\"</tt></li></ul></div></li><li> <span id=\"city-2-2170082088190540148\">\n <a href=\"#city-2-2170082088190540148\" class=\"anchor\">\n <tt>city</tt>\n </a>\n </span>\n<div class=\"schema\"><ul><li>Required: no</li><li>Type: string</li><li>Example: <tt>\"San Francisco, CA\"</tt></li></ul></div></li></ul></div></li></ul></div></li><li> <span id=\"created_at-0--3863856295782724640\">\n <a href=\"#created_at-0--3863856295782724640\" class=\"anchor\">\n <tt>created_at</tt>\n </a>\n </span>\n<div class=\"schema\"><ul><li>Required: no</li><li>Type: string</li><li>Format: date-time</li><li>Example: <tt>\"2015-06-05T05:53:46.749-07:00\"</tt></li></ul></div></li><li> <span id=\"funnel-0--535556761852237600\">\n <a href=\"#funnel-0--535556761852237600\" class=\"anchor\">\n <tt>funnel</tt>\n </a>\n </span>\n<div class=\"schema\"><ul><li>Required: no</li><li>additionalProperties: false</li><li> <span id=\"id-1-979689635089775780\">\n <a href=\"#id-1-979689635089775780\" class=\"anchor\">\n <tt>id</tt>\n </a>\n </span>\n<div class=\"schema\"><ul><li>Required: no</li><li>Type: string</li><li>Example: <tt>\"de79f80f-43da-4e4c-87d6-9bf714753535\"</tt></li></ul></div></li><li> <span id=\"title-1-3996638107768797980\">\n <a href=\"#title-1-3996638107768797980\" class=\"anchor\">\n <tt>title</tt>\n </a>\n </span>\n<div class=\"schema\"><ul><li>Required: no</li><li>Type: string</li><li>Example: <tt>\"Corporate Security Facilitator\"</tt></li></ul></div></li></ul></div></li><li> <span id=\"stage-0--617248999000103264\">\n <a href=\"#stage-0--617248999000103264\" class=\"anchor\">\n <tt>stage</tt>\n </a>\n </span>\n<div class=\"schema\"><ul><li>Required: no</li><li>additionalProperties: false</li><li> <span id=\"id-1-4030627740244284332\">\n <a href=\"#id-1-4030627740244284332\" class=\"anchor\">\n <tt>id</tt>\n </a>\n </span>\n<div class=\"schema\"><ul><li>Required: no</li><li>Type: string</li><li>Example: <tt>\"4d09fca4-6599-4418-b385-6cf173e01b66\"</tt></li></ul></div></li><li> <span id=\"title-1--656844964611395908\">\n <a href=\"#title-1--656844964611395908\" class=\"anchor\">\n <tt>title</tt>\n </a>\n </span>\n<div class=\"schema\"><ul><li>Required: no</li><li>Type: string</li><li>Example: <tt>\"Approved\"</tt></li></ul></div></li></ul></div></li><li> <span id=\"background_checks-0-1093283633238088424\">\n <a href=\"#background_checks-0-1093283633238088424\" class=\"anchor\">\n <tt>background_checks</tt>\n </a>\n </span>\n<div class=\"schema\"><ul><li>Required: no</li><li>Type: array</li><li>Items<div class=\"schema\"><ul><li>Required: no</li><li>additionalProperties: false</li><li> <span id=\"title-2--3490851928509029076\">\n <a href=\"#title-2--3490851928509029076\" class=\"anchor\">\n <tt>title</tt>\n </a>\n </span>\n<div class=\"schema\"><ul><li>Required: no</li><li>Type: string</li><li>Example: <tt>\"Driver license check\"</tt></li></ul></div></li><li> <span id=\"status-2--1378084316743439420\">\n <a href=\"#status-2--1378084316743439420\" class=\"anchor\">\n <tt>status</tt>\n </a>\n </span>\n<div class=\"schema\"><ul><li>Required: no</li><li>Type: string</li><li>Example: <tt>\"pending\"</tt></li></ul></div></li><li> <span id=\"vendor-2--1116928499757215828\">\n <a href=\"#vendor-2--1116928499757215828\" class=\"anchor\">\n <tt>vendor</tt>\n </a>\n </span>\n<div class=\"schema\"><ul><li>Required: no</li><li>Type: string</li><li>Example: <tt>\"checkr\"</tt></li></ul></div></li><li> <span id=\"candidate_id-2--766588445614545596\">\n <a href=\"#candidate_id-2--766588445614545596\" class=\"anchor\">\n <tt>candidate_id</tt>\n </a>\n </span>\n<div class=\"schema\"><ul><li>Required: no</li><li>Type: string</li><li>Example: <tt>\"e44aa283528e6fde7d542194\"</tt></li></ul></div></li><li> <span id=\"report_id-2-2224626826341256068\">\n <a href=\"#report_id-2-2224626826341256068\" class=\"anchor\">\n <tt>report_id</tt>\n </a>\n </span>\n<div class=\"schema\"><ul><li>Required: no</li><li>Type: string</li><li>Example: <tt>\"4722c07dd9a10c3985ae432a\"</tt></li></ul></div></li></ul></div></li></ul></div></li><li> <span id=\"document_signatures-0-282550241065113700\">\n <a href=\"#document_signatures-0-282550241065113700\" class=\"anchor\">\n <tt>document_signatures</tt>\n </a>\n </span>\n<div class=\"schema\"><ul><li>Required: no</li><li>Type: array</li><li>Items<div class=\"schema\"><ul><li>Required: no</li><li>additionalProperties: false</li><li> <span id=\"vendor-2--3080330108168517492\">\n <a href=\"#vendor-2--3080330108168517492\" class=\"anchor\">\n <tt>vendor</tt>\n </a>\n </span>\n<div class=\"schema\"><ul><li>Required: no</li><li>Type: string</li><li>Example: <tt>\"hellosign\"</tt></li></ul></div></li><li> <span id=\"signature_id-2-498352775983210796\">\n <a href=\"#signature_id-2-498352775983210796\" class=\"anchor\">\n <tt>signature_id</tt>\n </a>\n </span>\n<div class=\"schema\">Vendor-specific signature ID<ul><li>Required: no</li><li>Type: string</li><li>Example: <tt>\"123dfdsf\"</tt></li></ul></div></li><li> <span id=\"status-2--2367106194852174228\">\n <a href=\"#status-2--2367106194852174228\" class=\"anchor\">\n <tt>status</tt>\n </a>\n </span>\n<div class=\"schema\">Status of this request (opened, signed or admin_reviewed)<ul><li>Required: no</li><li>Type: string</li><li>Example: <tt>\"signed\"</tt></li></ul></div></li></ul></div></li></ul></div></li><li> <span id=\"labels-0--2248149293993269276\">\n <a href=\"#labels-0--2248149293993269276\" class=\"anchor\">\n <tt>labels</tt>\n </a>\n </span>\n<div class=\"schema\"><ul><li>Required: no</li><li>Type: array</li><li>Items<div class=\"schema\"><ul><li>Required: no</li><li>additionalProperties: false</li><li> <span id=\"title-2--1766485754682808260\">\n <a href=\"#title-2--1766485754682808260\" class=\"anchor\">\n <tt>title</tt>\n </a>\n </span>\n<div class=\"schema\"><ul><li>Required: no</li><li>Type: string</li><li>Example: <tt>\"Label-0\"</tt></li></ul></div></li><li> <span id=\"completed-2--103234745214925392\">\n <a href=\"#completed-2--103234745214925392\" class=\"anchor\">\n <tt>completed</tt>\n </a>\n </span>\n<div class=\"schema\"><ul><li>Required: no</li><li>Type: boolean</li><li>Example: <tt>false</tt></li></ul></div></li></ul></div></li></ul></div></li></ul>" } [/block]

User Information

Try It Out

post
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}