{"_id":"59de6011debd1200240f6930","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"},"parentDoc":null,"project":"59de6011debd1200240f68ec","__v":10,"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-22T04:01:56.675Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"method":"get","results":{"codes":[{"name":"","code":"{\n  \"id\": \"550e8400-e29b-41d4-a716-446655440000\",\n  \"email\": \"reggie.langworth:::at:::powlowski.info\",\n  \"name\": \"Fred\",\n  \"phone_number\": \"7816895444\",\n  \"data\": {},\n  \"created_at\": \"2015-06-05T05:53:33.708-07:00\",\n  \"funnel\": {\n    \"id\": \"2a89059c-8a8f-4434-810a-fd76f7170f8e\",\n    \"title\": \"Human Usability Facilitator\",\n    \"custom_id\": \"3d67750a-dcf4-4ada-a3e4-ee44661949fc\",\n    \"location\": {\n      \"id\": \"7f88228c-cba9-4827-b71d-e81244c05d37\",\n      \"name\": \"San Francisco\"\n    }\n  },\n  \"stage\": {\n    \"id\": \"b3788ad7-13ac-4e69-b904-b594f4f018ce\",\n    \"title\": \"Approved\"\n  },\n  \"background_checks\": [\n    {\n      \"title\": \"Background Check\",\n      \"applicant_id\": \"0003a183-bcc5-41f8-8410-2bc7bfg53aee\",\n      \"check_id\": \"123c33ca-bacd-4336-9b06-fdf8336fc48e\",\n      \"status\": \"clear\",\n      \"vendor\": \"onfido\"\n    }\n  ],\n  \"document_signatures\": [\n    {\n      \"vendor\": \"hellosign\",\n      \"signature_id\": \"fa5c8a0b0f492d768749333ad6fcc214c111e967\",\n      \"status\": \"signed\",\n      \"url\": \"https://s3.amazon.com\n    }\n  ],\n  \"labels\": [\n    {\n      \"title\": \"Label-1\",\n      \"completed\": true\n    }\n  ],\n  \"score_cards_results\": [\n    {\n      \"score\": \"\",\n      \"created_at\": \"\",\n      \"user\": {\n        \"id\": \"\",\n        \"name\": \"\",\n        \"email\": \"\"\n      },\n      \"template\": {\n        \"name\": \"\",\n        \"weighted\": \"\"\n      },\n      \"answers\": [\n        {\n          \"score\": \"\",\n          \"note\": \"\",\n          \"question\": {\n            \"text\": \"\",\n            \"weight\": \"\"\n          }\n        }\n      ]\n    }\n  ],\n  \"rejection_reason\": \"not a good fit\",\n  \"on_hold_reason\": \"processing documents\"\n}","language":"json","status":200},{"name":"","code":"{\n  \"message\": \"Authentication is required\"\n}","language":"json","status":401}]},"settings":"","examples":{"codes":[{"language":"curl","code":"curl -X GET -d 'api_token=secret-api-token' 'https://api.fountain.com/v2/applicants/550e8400-e29b-41d4-a716-446655440000'"}]},"auth":"required","params":[{"_id":"56ca8b110df8240b00e3f52d","ref":"","in":"path","required":true,"desc":"ID must be included in the URL","default":"550e8400-e29b-41d4-a716-446655440000","type":"string","name":"id"},{"_id":"5b3c0a097f7b890003364f0a","ref":"","in":"query","required":false,"desc":"Required if api_token is not passed in header","default":"secret-api-token","type":"string","name":"api_token"}],"url":"/applicants/:id"},"isReference":false,"order":4,"body":"A standard GET call for applicant info yields any data which was not collected via a secure field in our forms. To allow access to secure data, contact Fountain at support@fountain.com for help. We'll provide you with a secure-fields specific API key which you can use with Get Applicant info to retrieve secure data with the rest of an applicant's information.\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Name, Email, Phone Number\",\n  \"body\": \"By default, the fields containing name, email, and phone number are stored outside the data array, as shown below. These three fields are defaults required for any applicants within Fountain.\"\n}\n[/block]\n## Response Schema\n[block:html]\n{\n  \"html\": \"<ul><li>additionalProperties: false</li><li>    <span id=\\\"id-0-672104627050982272\\\">\\n      <a href=\\\"#id-0-672104627050982272\\\" 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>\\\"550e8400-e29b-41d4-a716-446655440000\\\"</tt></li></ul></div></li><li>    <span id=\\\"email-0-101608317442150528\\\">\\n      <a href=\\\"#email-0-101608317442150528\\\" 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>\\\"reggie.langworth@powlowski.info\\\"</tt></li></ul></div></li><li>    <span id=\\\"name-0-3440702756384431596\\\">\\n      <a href=\\\"#name-0-3440702756384431596\\\" 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>\\\"Fred\\\"</tt></li></ul></div></li><li>    <span id=\\\"phone_number-0--2690065620461446420\\\">\\n      <a href=\\\"#phone_number-0--2690065620461446420\\\" 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>\\\"7816895444\\\"</tt></li></ul></div></li><li>    <span id=\\\"data-0--4533662754883485716\\\">\\n      <a href=\\\"#data-0--4533662754883485716\\\" class=\\\"anchor\\\">\\n        <tt>data</tt>\\n      </a>\\n    </span>\\n<div class=\\\"schema\\\"><ul><li>Required: no</li><li>additionalProperties: false</li></ul></div></li><li>    <span id=\\\"created_at-0-859419271164741364\\\">\\n      <a href=\\\"#created_at-0-859419271164741364\\\" 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:33.708-07:00\\\"</tt></li></ul></div></li><li>    <span id=\\\"funnel-0-3709623341629663081\\\">\\n      <a href=\\\"#funnel-0-3709623341629663081\\\" class=\\\"anchor\\\">\\n        <tt>funnel</tt>\\n      </a>\\n    </span>\\n<div class=\\\"schema\\\"><ul><li>Required: yes</li><li>additionalProperties: false</li><li>    <span id=\\\"id-1-3986154121405950263\\\">\\n      <a href=\\\"#id-1-3986154121405950263\\\" class=\\\"anchor\\\">\\n        <tt>id</tt>\\n      </a>\\n    </span>\\n<div class=\\\"schema\\\"><ul><li>Required: yes</li><li>Type: string</li><li>Example: <tt>\\\"2a89059c-8a8f-4434-810a-fd76f7170f8e\\\"</tt></li></ul></div></li><li>    <span id=\\\"title-1-1686309766258628444\\\">\\n      <a href=\\\"#title-1-1686309766258628444\\\" class=\\\"anchor\\\">\\n        <tt>title</tt>\\n      </a>\\n    </span>\\n<div class=\\\"schema\\\"><ul><li>Required: yes</li><li>Type: string</li><li>Example: <tt>\\\"Human Usability Facilitator\\\"</tt></li></ul></div></li><li>    <span id=\\\"custom_id-1--669055527776895356\\\">\\n      <a href=\\\"#custom_id-1--669055527776895356\\\" class=\\\"anchor\\\">\\n        <tt>custom_id</tt>\\n      </a>\\n    </span>\\n<div class=\\\"schema\\\"><ul><li>Required: yes</li><li>Type: string</li><li>Example: <tt>\\\"3d67750a-dcf4-4ada-a3e4-ee44661949fc\\\"</tt></li></ul></div></li><li>    <span id=\\\"location-1--2971151682268075956\\\">\\n      <a href=\\\"#location-1--2971151682268075956\\\" class=\\\"anchor\\\">\\n        <tt>location</tt>\\n      </a>\\n    </span>\\n<div class=\\\"schema\\\"><ul><li>Required: no</li><li>additionalProperties: false</li><li>    <span id=\\\"id-2--2692368965241246070\\\">\\n      <a href=\\\"#id-2--2692368965241246070\\\" class=\\\"anchor\\\">\\n        <tt>id</tt>\\n      </a>\\n    </span>\\n<div class=\\\"schema\\\"><ul><li>Required: yes</li><li>Type: string</li><li>Example: <tt>\\\"7f88228c-cba9-4827-b71d-e81244c05d37\\\"</tt></li></ul></div></li><li>    <span id=\\\"name-2--3897653929471515220\\\">\\n      <a href=\\\"#name-2--3897653929471515220\\\" class=\\\"anchor\\\">\\n        <tt>name</tt>\\n      </a>\\n    </span>\\n<div class=\\\"schema\\\"><ul><li>Required: yes</li><li>Type: string</li><li>Example: <tt>\\\"San Francisco\\\"</tt></li></ul></div></li></ul></div></li></ul></div></li><li>    <span id=\\\"stage-0-3734354038418732256\\\">\\n      <a href=\\\"#stage-0-3734354038418732256\\\" 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-4031582959873402596\\\">\\n      <a href=\\\"#id-1-4031582959873402596\\\" 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>\\\"b3788ad7-13ac-4e69-b904-b594f4f018ce\\\"</tt></li></ul></div></li><li>    <span id=\\\"title-1-3784233717490827764\\\">\\n      <a href=\\\"#title-1-3784233717490827764\\\" 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-632807307221307460\\\">\\n      <a href=\\\"#background_checks-0-632807307221307460\\\" 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--3867915126349057176\\\">\\n      <a href=\\\"#title-2--3867915126349057176\\\" 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-1693309576812215636\\\">\\n      <a href=\\\"#status-2-1693309576812215636\\\" 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-1253865106056712788\\\">\\n      <a href=\\\"#vendor-2-1253865106056712788\\\" 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--127776851372798124\\\">\\n      <a href=\\\"#candidate_id-2--127776851372798124\\\" 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--1316709479614905260\\\">\\n      <a href=\\\"#report_id-2--1316709479614905260\\\" 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--4116675663845547376\\\">\\n      <a href=\\\"#document_signatures-0--4116675663845547376\\\" 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--920357252634491268\\\">\\n      <a href=\\\"#vendor-2--920357252634491268\\\" class=\\\"anchor\\\">\\n        <tt>vendor</tt>\\n      </a>\\n    </span>\\n<div class=\\\"schema\\\">Signature service vendor (hellosign or docusign)<ul><li>Required: yes</li><li>Type: string</li><li>Example: <tt>\\\"hellosign\\\"</tt></li></ul></div></li><li>    <span id=\\\"signature_id-2--3566482603799954684\\\">\\n      <a href=\\\"#signature_id-2--3566482603799954684\\\" class=\\\"anchor\\\">\\n        <tt>signature_id</tt>\\n      </a>\\n    </span>\\n<div class=\\\"schema\\\">Vendor-specific signature ID<ul><li>Required: yes</li><li>Type: string</li><li>Example: <tt>\\\"fa5c8a0b0f492d768749333ad6fcc214c111e967\\\"</tt></li></ul></div></li><li>    <span id=\\\"status-2--3141376181114124020\\\">\\n      <a href=\\\"#status-2--3141376181114124020\\\" 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: yes</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-3159467023744124124\\\">\\n      <a href=\\\"#labels-0-3159467023744124124\\\" 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--3201762928903813172\\\">\\n      <a href=\\\"#title-2--3201762928903813172\\\" 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-1\\\"</tt></li></ul></div></li><li>    <span id=\\\"completed-2-541846512746442776\\\">\\n      <a href=\\\"#completed-2-541846512746442776\\\" 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":"Get an applicant's data as it is stored in Fountain.","slug":"get-applicant-info","type":"endpoint","title":"Get Applicant Info"}

getGet Applicant Info

Get an applicant's data as it is stored in Fountain.

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

id:
required
string550e8400-e29b-41d4-a716-446655440000
ID must be included in the URL

Query Params

api_token:
stringsecret-api-token
Required if api_token is not passed in header

Examples


Result Format


Documentation

A standard GET call for applicant info yields any data which was not collected via a secure field in our forms. To allow access to secure data, contact Fountain at support@fountain.com for help. We'll provide you with a secure-fields specific API key which you can use with Get Applicant info to retrieve secure data with the rest of an applicant's information. [block:callout] { "type": "info", "title": "Name, Email, Phone Number", "body": "By default, the fields containing name, email, and phone number are stored outside the data array, as shown below. These three fields are defaults required for any applicants within Fountain." } [/block] ## Response Schema [block:html] { "html": "<ul><li>additionalProperties: false</li><li> <span id=\"id-0-672104627050982272\">\n <a href=\"#id-0-672104627050982272\" 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>\"550e8400-e29b-41d4-a716-446655440000\"</tt></li></ul></div></li><li> <span id=\"email-0-101608317442150528\">\n <a href=\"#email-0-101608317442150528\" 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>\"reggie.langworth@powlowski.info\"</tt></li></ul></div></li><li> <span id=\"name-0-3440702756384431596\">\n <a href=\"#name-0-3440702756384431596\" 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>\"Fred\"</tt></li></ul></div></li><li> <span id=\"phone_number-0--2690065620461446420\">\n <a href=\"#phone_number-0--2690065620461446420\" 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>\"7816895444\"</tt></li></ul></div></li><li> <span id=\"data-0--4533662754883485716\">\n <a href=\"#data-0--4533662754883485716\" class=\"anchor\">\n <tt>data</tt>\n </a>\n </span>\n<div class=\"schema\"><ul><li>Required: no</li><li>additionalProperties: false</li></ul></div></li><li> <span id=\"created_at-0-859419271164741364\">\n <a href=\"#created_at-0-859419271164741364\" 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:33.708-07:00\"</tt></li></ul></div></li><li> <span id=\"funnel-0-3709623341629663081\">\n <a href=\"#funnel-0-3709623341629663081\" class=\"anchor\">\n <tt>funnel</tt>\n </a>\n </span>\n<div class=\"schema\"><ul><li>Required: yes</li><li>additionalProperties: false</li><li> <span id=\"id-1-3986154121405950263\">\n <a href=\"#id-1-3986154121405950263\" class=\"anchor\">\n <tt>id</tt>\n </a>\n </span>\n<div class=\"schema\"><ul><li>Required: yes</li><li>Type: string</li><li>Example: <tt>\"2a89059c-8a8f-4434-810a-fd76f7170f8e\"</tt></li></ul></div></li><li> <span id=\"title-1-1686309766258628444\">\n <a href=\"#title-1-1686309766258628444\" class=\"anchor\">\n <tt>title</tt>\n </a>\n </span>\n<div class=\"schema\"><ul><li>Required: yes</li><li>Type: string</li><li>Example: <tt>\"Human Usability Facilitator\"</tt></li></ul></div></li><li> <span id=\"custom_id-1--669055527776895356\">\n <a href=\"#custom_id-1--669055527776895356\" class=\"anchor\">\n <tt>custom_id</tt>\n </a>\n </span>\n<div class=\"schema\"><ul><li>Required: yes</li><li>Type: string</li><li>Example: <tt>\"3d67750a-dcf4-4ada-a3e4-ee44661949fc\"</tt></li></ul></div></li><li> <span id=\"location-1--2971151682268075956\">\n <a href=\"#location-1--2971151682268075956\" class=\"anchor\">\n <tt>location</tt>\n </a>\n </span>\n<div class=\"schema\"><ul><li>Required: no</li><li>additionalProperties: false</li><li> <span id=\"id-2--2692368965241246070\">\n <a href=\"#id-2--2692368965241246070\" class=\"anchor\">\n <tt>id</tt>\n </a>\n </span>\n<div class=\"schema\"><ul><li>Required: yes</li><li>Type: string</li><li>Example: <tt>\"7f88228c-cba9-4827-b71d-e81244c05d37\"</tt></li></ul></div></li><li> <span id=\"name-2--3897653929471515220\">\n <a href=\"#name-2--3897653929471515220\" class=\"anchor\">\n <tt>name</tt>\n </a>\n </span>\n<div class=\"schema\"><ul><li>Required: yes</li><li>Type: string</li><li>Example: <tt>\"San Francisco\"</tt></li></ul></div></li></ul></div></li></ul></div></li><li> <span id=\"stage-0-3734354038418732256\">\n <a href=\"#stage-0-3734354038418732256\" 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-4031582959873402596\">\n <a href=\"#id-1-4031582959873402596\" 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>\"b3788ad7-13ac-4e69-b904-b594f4f018ce\"</tt></li></ul></div></li><li> <span id=\"title-1-3784233717490827764\">\n <a href=\"#title-1-3784233717490827764\" 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-632807307221307460\">\n <a href=\"#background_checks-0-632807307221307460\" 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--3867915126349057176\">\n <a href=\"#title-2--3867915126349057176\" 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-1693309576812215636\">\n <a href=\"#status-2-1693309576812215636\" 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-1253865106056712788\">\n <a href=\"#vendor-2-1253865106056712788\" 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--127776851372798124\">\n <a href=\"#candidate_id-2--127776851372798124\" 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--1316709479614905260\">\n <a href=\"#report_id-2--1316709479614905260\" 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--4116675663845547376\">\n <a href=\"#document_signatures-0--4116675663845547376\" 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--920357252634491268\">\n <a href=\"#vendor-2--920357252634491268\" class=\"anchor\">\n <tt>vendor</tt>\n </a>\n </span>\n<div class=\"schema\">Signature service vendor (hellosign or docusign)<ul><li>Required: yes</li><li>Type: string</li><li>Example: <tt>\"hellosign\"</tt></li></ul></div></li><li> <span id=\"signature_id-2--3566482603799954684\">\n <a href=\"#signature_id-2--3566482603799954684\" class=\"anchor\">\n <tt>signature_id</tt>\n </a>\n </span>\n<div class=\"schema\">Vendor-specific signature ID<ul><li>Required: yes</li><li>Type: string</li><li>Example: <tt>\"fa5c8a0b0f492d768749333ad6fcc214c111e967\"</tt></li></ul></div></li><li> <span id=\"status-2--3141376181114124020\">\n <a href=\"#status-2--3141376181114124020\" 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: yes</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-3159467023744124124\">\n <a href=\"#labels-0-3159467023744124124\" 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--3201762928903813172\">\n <a href=\"#title-2--3201762928903813172\" 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-1\"</tt></li></ul></div></li><li> <span id=\"completed-2-541846512746442776\">\n <a href=\"#completed-2-541846512746442776\" 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

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