{"_id":"59de6011debd1200240f692b","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","user":"547504ed59fade080004cb8b","__v":2,"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"},"githubsync":"","metadata":{"title":"","description":"","image":[]},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-02-22T07:03:57.477Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[{"code":"curl -X GET -d 'api_token=secret-api-token' 'https://api.fountain.com/v2/applicants/22222222-0000-0000-0000-000000000000/secure_documents'\n\n","language":"curl"},{"code":"www.onboardiq.com/api/v2/applicants/22222222-0000-0000-0000-000000000000/secure_documents/?api_token=secret-api-token","language":"text"}]},"method":"get","results":{"codes":[{"name":"","status":200,"language":"json","code":"{\n  \"secure_documents\": [\n    {\n      \"id\": \"a71d7cf4-2d9d-4d4b-82ef-8894bbe78120\",\n      \"name\": \"upload_one\",\n      \"friendly_name\": \"Upload one\",\n      \"filename\": \"CCUzGocUMAEPkN3.jpg\",\n      \"public_url\": \"https://api.truevault.com/v1/download?access_key=AAABBBCCC&expiration=2016-03-31T06%3A41%3A03-07%3A00&request=DDDEEEFFF&signature=HHHIIIJJJ\",\n      \"size\": 25718,\n      \"approved\": false,\n      \"stage\": {\n        \"id\": \"1ac2f82c-caa9-4b13-ad5b-df555e050524\",\n        \"title\": \"Approved\"\n      }\n    }\n  ]\n}"}]},"settings":"","auth":"required","params":[{"_id":"576848f3d98cfd0e00676135","ref":"","in":"query","required":false,"desc":"","default":"secret-api-token","type":"string","name":"api_token"},{"_id":"579bf03db764640e007b4e58","ref":"","in":"path","required":true,"desc":"An applicant's UUID","default":"22222222-0000-0000-0000-000000000000","type":"string","name":"applicant_id"}],"url":"/applicants/:applicant_id/secure_documents"},"isReference":false,"order":6,"body":"To store sensitive information, Fountain supports secure documents to manage personally identifiable information such as Drivers License photos, insurance documents, and more. Furthermore, any custom file uploads you request from applicants are also protected with secure docs.\n\n[block:callout]\n{\n  \"type\": \"warning\",\n  \"title\": \"Contact us if you need to access documents via API!\",\n  \"body\": \"Fountain needs to enable your account to GET applicant files via API. Please contact us to request access if you need it.\"\n}\n[/block]\nBelow is the response schema including secure docs, so you can understand how they are structured in a JSON object. Each document will have a custom link to the doc for direct access to it through TrueVault.\n\n## Response Schema\n[block:html]\n{\n  \"html\": \"<ul><li>additionalProperties: false</li><li>    <span id=\\\"secure_documents-0--1701295507822031938\\\">\\n      <a href=\\\"#secure_documents-0--1701295507822031938\\\" class=\\\"anchor\\\">\\n        <tt>secure_documents</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=\\\"id-2-1578854003853450853\\\">\\n      <a href=\\\"#id-2-1578854003853450853\\\" 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>\\\"a71d7cf4-2d9d-4d4b-82ef-8894bbe78120\\\"</tt></li></ul></div></li><li>    <span id=\\\"name-2-3558860920565534347\\\">\\n      <a href=\\\"#name-2-3558860920565534347\\\" 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>\\\"upload_one\\\"</tt></li></ul></div></li><li>    <span id=\\\"friendly_name-2--2138604512024806693\\\">\\n      <a href=\\\"#friendly_name-2--2138604512024806693\\\" class=\\\"anchor\\\">\\n        <tt>friendly_name</tt>\\n      </a>\\n    </span>\\n<div class=\\\"schema\\\"><ul><li>Required: no</li><li>Type: string</li><li>Example: <tt>\\\"Upload one\\\"</tt></li></ul></div></li><li>    <span id=\\\"filename-2--3776326707893562438\\\">\\n      <a href=\\\"#filename-2--3776326707893562438\\\" class=\\\"anchor\\\">\\n        <tt>filename</tt>\\n      </a>\\n    </span>\\n<div class=\\\"schema\\\"><ul><li>Required: no</li><li>Type: string</li><li>Example: <tt>\\\"CCUzGocUMAEPkN3.jpg\\\"</tt></li></ul></div></li><li>    <span id=\\\"public_url-2--4563915555562126390\\\">\\n      <a href=\\\"#public_url-2--4563915555562126390\\\" class=\\\"anchor\\\">\\n        <tt>public_url</tt>\\n      </a>\\n    </span>\\n<div class=\\\"schema\\\"><ul><li>Required: no</li><li>Type: string</li><li>Example: <tt>\\\"https://api.truevault.com/v1/download?access_key=AAABBBCCC&amp;expiration=2016-03-31T06%3A41%3A03-07%3A00&amp;request=DDDEEEFFF&amp;signature=HHHIIIJJJ\\\"</tt></li></ul></div></li><li>    <span id=\\\"size-2-446145827542876173\\\">\\n      <a href=\\\"#size-2-446145827542876173\\\" class=\\\"anchor\\\">\\n        <tt>size</tt>\\n      </a>\\n    </span>\\n<div class=\\\"schema\\\"><ul><li>Required: no</li><li>Type: integer</li><li>Example: <tt>25718</tt></li></ul></div></li><li>    <span id=\\\"stage-2--4203587862246608349\\\">\\n      <a href=\\\"#stage-2--4203587862246608349\\\" 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-3-1546135653662519363\\\">\\n      <a href=\\\"#id-3-1546135653662519363\\\" 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>\\\"1ac2f82c-caa9-4b13-ad5b-df555e050524\\\"</tt></li></ul></div></li><li>    <span id=\\\"title-3-803152795830214678\\\">\\n      <a href=\\\"#title-3-803152795830214678\\\" 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></ul></div></li></ul></div></li></ul>\"\n}\n[/block]","excerpt":"Accessing documents from Fountain","slug":"secure-documents","type":"endpoint","title":"Get Applicant Documents"}

getGet Applicant Documents

Accessing documents from Fountain

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

applicant_id:
required
string22222222-0000-0000-0000-000000000000
An applicant's UUID

Query Params

api_token:
stringsecret-api-token

Examples


Result Format


Documentation

To store sensitive information, Fountain supports secure documents to manage personally identifiable information such as Drivers License photos, insurance documents, and more. Furthermore, any custom file uploads you request from applicants are also protected with secure docs. [block:callout] { "type": "warning", "title": "Contact us if you need to access documents via API!", "body": "Fountain needs to enable your account to GET applicant files via API. Please contact us to request access if you need it." } [/block] Below is the response schema including secure docs, so you can understand how they are structured in a JSON object. Each document will have a custom link to the doc for direct access to it through TrueVault. ## Response Schema [block:html] { "html": "<ul><li>additionalProperties: false</li><li> <span id=\"secure_documents-0--1701295507822031938\">\n <a href=\"#secure_documents-0--1701295507822031938\" class=\"anchor\">\n <tt>secure_documents</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=\"id-2-1578854003853450853\">\n <a href=\"#id-2-1578854003853450853\" 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>\"a71d7cf4-2d9d-4d4b-82ef-8894bbe78120\"</tt></li></ul></div></li><li> <span id=\"name-2-3558860920565534347\">\n <a href=\"#name-2-3558860920565534347\" 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>\"upload_one\"</tt></li></ul></div></li><li> <span id=\"friendly_name-2--2138604512024806693\">\n <a href=\"#friendly_name-2--2138604512024806693\" class=\"anchor\">\n <tt>friendly_name</tt>\n </a>\n </span>\n<div class=\"schema\"><ul><li>Required: no</li><li>Type: string</li><li>Example: <tt>\"Upload one\"</tt></li></ul></div></li><li> <span id=\"filename-2--3776326707893562438\">\n <a href=\"#filename-2--3776326707893562438\" class=\"anchor\">\n <tt>filename</tt>\n </a>\n </span>\n<div class=\"schema\"><ul><li>Required: no</li><li>Type: string</li><li>Example: <tt>\"CCUzGocUMAEPkN3.jpg\"</tt></li></ul></div></li><li> <span id=\"public_url-2--4563915555562126390\">\n <a href=\"#public_url-2--4563915555562126390\" class=\"anchor\">\n <tt>public_url</tt>\n </a>\n </span>\n<div class=\"schema\"><ul><li>Required: no</li><li>Type: string</li><li>Example: <tt>\"https://api.truevault.com/v1/download?access_key=AAABBBCCC&amp;expiration=2016-03-31T06%3A41%3A03-07%3A00&amp;request=DDDEEEFFF&amp;signature=HHHIIIJJJ\"</tt></li></ul></div></li><li> <span id=\"size-2-446145827542876173\">\n <a href=\"#size-2-446145827542876173\" class=\"anchor\">\n <tt>size</tt>\n </a>\n </span>\n<div class=\"schema\"><ul><li>Required: no</li><li>Type: integer</li><li>Example: <tt>25718</tt></li></ul></div></li><li> <span id=\"stage-2--4203587862246608349\">\n <a href=\"#stage-2--4203587862246608349\" 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-3-1546135653662519363\">\n <a href=\"#id-3-1546135653662519363\" 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>\"1ac2f82c-caa9-4b13-ad5b-df555e050524\"</tt></li></ul></div></li><li> <span id=\"title-3-803152795830214678\">\n <a href=\"#title-3-803152795830214678\" 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></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 }}