|API

Check presence of data in a user's vault

get/users/{fp_id}/vault

External ID

Retrieve information on which Data Identifiers are present in the user's vault.

Request

Path parameters

fp_id·

string

Query parameters

fields·

optional array

Optionally, a comma-separated list of fields whose existence to check. For example, id.first_name,id.ssn4,custom.account_id

Response

A key-value map of identifier to whether the identifier exists in the vault

<key>·

string

Allowed values:

id.first_nameid.middle_nameid.last_nameid.dobid.ssn4id.ssn9id.address_line1id.address_line2id.cityid.stateid.zipid.countryid.emailid.phone_numberid.us_legal_statusid.visa_kindid.visa_expiration_dateid.nationalityid.citizenshipsid.drivers_license_numberid.drivers_license_stateid.itinid.us_tax_id

custom.*

investor_profile.employment_statusinvestor_profile.occupationinvestor_profile.employerinvestor_profile.annual_incomeinvestor_profile.net_worthinvestor_profile.investment_goalsinvestor_profile.risk_toleranceinvestor_profile.declarationsinvestor_profile.brokerage_firm_employerinvestor_profile.senior_executive_symbolsinvestor_profile.family_member_namesinvestor_profile.political_organizationinvestor_profile.funding_sources

document.id_card.front.imagedocument.id_card.front.mime_typedocument.id_card.back.image

<value>·

boolean

GET /users/{fp_id}/vault

1curl https://api.onefootprint.com/users/{fp_id}/vault \
2  -u sk_test_xxxxx:

Response example

{
  "id.first_name": true,
  "id.ssn9": true,
  "custom.credit_card": true,
  "id.dob": false
}