{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/applicants/:applicant_id/secure_documents","auth":"required","examples":{"codes":[{"language":"curl","code":"curl -X GET -H 'X-ACCESS-TOKEN: secret-api-token' 'https://api.fountain.com/v2/applicants/22222222-0000-0000-0000-000000000000/secure_documents'\n\n"},{"language":"text","code":"www.onboardiq.com/api/v2/applicants/22222222-0000-0000-0000-000000000000/secure_documents/?api_token=secret-api-token"}]},"method":"get","results":{"codes":[{"code":"{\n  \"secure_documents\": [\n    {\n      \"name\": \"passport_photo\",\n      \"friendly_name\": \"Passport Photo\",\n      \"filename\": \"image.jpg\",\n      \"size\": 1232312,\n      \"approved\": false,\n      \"id\": \"6df3d34a-0ef2-12j8-9982-b214ad9f270f/c6b194b1-7200-4ec9-a482-f324f9492116/d61a1a04-0q0f-4ccb-bca4-eedc2e95c19f_image.jpg\",\n      \"public_url\": \"https://secure-data.fountain.com?k=i1jdXN0b21lci1rZXktbWQ1PU5DNCUyRjNTand4TllrUGpNSFc3SmVtUSUzRCUzRCZYLUFtei1\",\n      \"stage\": {\n        \"id\": \"02a654fa-cc56-4366-981f-f8f27f6a3595\",\n        \"title\": \"Screening Questions\",\n        \"form_title\": \"Screening Questions\",\n        \"form_description\": \"\"\n\n      }\n    }\n  ]\n}","language":"json","status":200,"name":""}]},"settings":"","params":[{"name":"applicant_id","type":"string","default":"22222222-0000-0000-0000-000000000000","desc":"An applicant's UUID","required":true,"in":"path","ref":"","_id":"579bf03db764640e007b4e58"},{"name":"X-ACCESS-TOKEN","type":"string","default":"secret-api-token","desc":"Access Token","required":true,"in":"header","ref":"","_id":"60db929614cba70079b2f1a3"}]},"next":{"description":"","pages":[]},"title":"Get Applicant Files","type":"endpoint","slug":"secure-documents","excerpt":"Accessing secure file uploads from Fountain.","body":"**This endpoint cannot be used without enabling secure file access for your account.** Please contact us to request access if you need to access applicant files via API.\n\nTo store sensitive information, Fountain supports secure files 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[block:callout]\n{\n  \"type\": \"warning\",\n  \"body\": \"The URL returned by this endpoint is only valid for 24 hours and is publicly accessible once generated. Please be cautious with how this URL is exposed.\",\n  \"title\": \"File URLs are public but temporary\"\n}\n[/block]\nBelow is the response schema including secure docs, so you can understand how they are structured in a JSON object. \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://secure-data.fountain.com?k=i1jdXN0b21lci1rZXktbWQ1PU5DNCUyRjNTand4TllrUGpNSFc3SmVtUSUzRCUzRCZYLUFtei1\\\"</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]","updates":[],"order":6,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"59de6011debd1200240f692b","version":{"version":"2.0","version_clean":"2.0.0","codename":"","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["59de6011debd1200240f68fb","59de6011debd1200240f68fa","59de6011debd1200240f68fc","59de6011debd1200240f68f8","59de6011debd1200240f68f7","59de6011debd1200240f68f9","59de6011debd1200240f68fd","59de6011debd1200240f68fe","59de6011debd1200240f68ff","5a8bfb99f4146e00449cec47","5a8bfcf2e86f530012159bb2","5cd4c29c6ea1040056ec0f55"],"_id":"59de6011debd1200240f68ee","__v":3,"project":"59de6011debd1200240f68ec","createdAt":"2016-06-20T18:15:42.514Z","releaseDate":"2016-06-20T18:15:42.514Z"},"parentDoc":null,"project":"59de6011debd1200240f68ec","user":"547504ed59fade080004cb8b","__v":15,"category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"Applicant Management","slug":"endpoints","order":2,"from_sync":false,"reference":false,"_id":"59de6011debd1200240f68fa","project":"59de6011debd1200240f68ec","version":"59de6011debd1200240f68ee","__v":0,"createdAt":"2016-02-19T01:01:16.044Z"},"createdAt":"2016-02-22T07:03:57.477Z","githubsync":""}

getGet Applicant Files

Accessing secure file uploads from Fountain.

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

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

Headers

X-ACCESS-TOKEN:
required
stringsecret-api-token
Access Token

Examples


Result Format


Documentation

**This endpoint cannot be used without enabling secure file access for your account.** Please contact us to request access if you need to access applicant files via API. To store sensitive information, Fountain supports secure files 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", "body": "The URL returned by this endpoint is only valid for 24 hours and is publicly accessible once generated. Please be cautious with how this URL is exposed.", "title": "File URLs are public but temporary" } [/block] Below is the response schema including secure docs, so you can understand how they are structured in a JSON object. ## 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://secure-data.fountain.com?k=i1jdXN0b21lci1rZXktbWQ1PU5DNCUyRjNTand4TllrUGpNSFc3SmVtUSUzRCUzRCZYLUFtei1\"</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 }}