{
"openapi": "3.0.0",
"info": {
"title": "Footprint API"
},
"servers": [
{
"url": "//api.onefootprint.com"
}
],
"paths": {
"/bank_links": {
"get": {
"tags": [
"Users",
"BankLinking",
"PreviewTenantApi"
],
"description": "Get a paginated list of links",
"parameters": [
{
"in": "query",
"name": "link_ids",
"description": "A comma separated list of link ids (if any) to filter by",
"schema": {
"example": "bal_123,bal_456",
"description": "A comma separated list of link ids (if any) to filter by",
"type": "string"
},
"style": "form"
},
{
"in": "query",
"name": "cursor",
"schema": {
"example": null,
"type": "string"
},
"style": "form"
},
{
"in": "query",
"name": "page_size",
"schema": {
"example": 10,
"type": "integer",
"format": "int64"
},
"style": "form"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CursorPaginatedLinkInfo"
}
}
}
}
},
"security": [
{
"Secret API Key": [
"preview:bank_linking"
]
}
]
},
"post": {
"tags": [
"Users",
"BankLinking",
"PreviewTenantApi"
],
"description": "Create a bank link from an intent",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CompleteIntentRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Link"
}
}
}
}
},
"security": [
{
"Secret API Key": [
"preview:bank_linking"
]
}
]
}
},
"/bank_links/{link_id}": {
"get": {
"tags": [
"Users",
"BankLinking",
"PreviewTenantApi"
],
"description": "Fetch a link",
"parameters": [
{
"in": "path",
"name": "link_id",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Link"
}
}
}
}
},
"security": [
{
"Secret API Key": [
"preview:bank_linking"
]
}
]
},
"delete": {
"tags": [
"Users",
"BankLinking",
"PreviewTenantApi"
],
"description": "Delete a bank account link",
"parameters": [
{
"in": "path",
"name": "link_id",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Empty"
}
}
}
}
},
"security": [
{
"Secret API Key": [
"preview:bank_linking"
]
}
]
}
},
"/bank_links/{link_id}/accounts": {
"get": {
"tags": [
"Users",
"BankLinking",
"PreviewTenantApi"
],
"description": "Fetch accounts for a bank link.",
"parameters": [
{
"in": "path",
"name": "link_id",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ListAccountsResponse"
}
}
}
}
},
"security": [
{
"Secret API Key": [
"preview:bank_linking"
]
}
]
}
},
"/bank_links/{link_id}/data_refresh": {
"post": {
"tags": [
"Users",
"BankLinking",
"PreviewTenantApi"
],
"description": "Request a refresh on linked bank account data",
"parameters": [
{
"in": "path",
"name": "link_id",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RefreshProductsRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Empty"
}
}
}
}
},
"security": [
{
"Secret API Key": [
"preview:bank_linking"
]
}
]
}
},
"/bank_links/{link_id}/import/transactions": {
"post": {
"tags": [
"Users",
"BankLinking",
"PreviewTenantApi"
],
"description": "Import a bank account transactions from a third party provider for a given bank link. The imported data has a maximum size limit of 1MB, which corresponds very roughly to about 4000 transactions. The data is processed synchronously, so you can expect a delay of up to 10 seconds before the response is transmitted.",
"parameters": [
{
"in": "path",
"name": "link_id",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ImportTransactionsRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Empty"
}
}
}
}
},
"security": [
{
"Secret API Key": [
"preview:bank_linking"
]
}
]
}
},
"/bank_links/{link_id}/investments/holdings": {
"get": {
"tags": [
"Users",
"BankLinking",
"PreviewTenantApi"
],
"description": "Fetch investment holdings for a given user's bank link.",
"parameters": [
{
"in": "path",
"name": "link_id",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
},
{
"in": "query",
"name": "account_ids",
"description": "An optional list of account IDs to filter the results (comma separated)",
"schema": {
"description": "An optional list of account IDs to filter the results (comma separated)",
"type": "array",
"items": {
"type": "string"
}
},
"style": "form"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ListInvestmentHoldingsResponse"
}
}
}
}
},
"security": [
{
"Secret API Key": [
"preview:bank_linking"
]
}
]
}
},
"/bank_links/{link_id}/investments/transactions": {
"get": {
"tags": [
"Users",
"BankLinking",
"PreviewTenantApi"
],
"description": "Fetch investment transactions for a given user's bank link.",
"parameters": [
{
"in": "path",
"name": "link_id",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
},
{
"in": "query",
"name": "account_ids",
"description": "An optional list of account IDs to filter the results (comma separated)",
"schema": {
"description": "An optional list of account IDs to filter the results (comma separated)",
"type": "array",
"items": {
"type": "string"
}
},
"style": "form"
},
{
"in": "query",
"name": "end_date",
"description": "The latest date for which data should be returned, formatted as YYYY-MM-DD",
"schema": {
"description": "The latest date for which data should be returned, formatted as YYYY-MM-DD",
"type": "string"
},
"style": "form"
},
{
"in": "query",
"name": "page",
"description": "The page number to return, defaults to 1",
"schema": {
"description": "The page number to return, defaults to 1",
"type": "integer",
"format": "int64"
},
"style": "form"
},
{
"in": "query",
"name": "size",
"description": "The number of results per page, max 100",
"schema": {
"description": "The number of results per page, max 100",
"type": "integer",
"format": "int64"
},
"style": "form"
},
{
"in": "query",
"name": "start_date",
"description": "The earliest date for which data should be returned, formatted as YYYY-MM-DD",
"schema": {
"description": "The earliest date for which data should be returned, formatted as YYYY-MM-DD",
"type": "string"
},
"style": "form"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ListInvestmentTransactionsResponse"
}
}
}
}
},
"security": [
{
"Secret API Key": [
"preview:bank_linking"
]
}
]
}
},
"/bank_links/{link_id}/reset": {
"post": {
"tags": [
"Users",
"BankLinking",
"PreviewTenantApi"
],
"description": "Disconnect a bank account link (for testing)",
"parameters": [
{
"in": "path",
"name": "link_id",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Empty"
}
}
}
}
},
"security": [
{
"Secret API Key": [
"preview:bank_linking"
]
}
]
}
},
"/bank_links/{link_id}/transactions": {
"get": {
"tags": [
"Users",
"BankLinking",
"PreviewTenantApi"
],
"description": "Fetch transactions for a bank link.",
"parameters": [
{
"in": "path",
"name": "link_id",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
},
{
"in": "query",
"name": "account_ids",
"description": "An optional list of account IDs to filter the results (comma separated)",
"schema": {
"description": "An optional list of account IDs to filter the results (comma separated)",
"type": "array",
"items": {
"type": "string"
}
},
"style": "form"
},
{
"in": "query",
"name": "end_date",
"description": "The latest date for which data should be returned, formatted as YYYY-MM-DD",
"schema": {
"description": "The latest date for which data should be returned, formatted as YYYY-MM-DD",
"type": "string"
},
"style": "form"
},
{
"in": "query",
"name": "page",
"description": "The page number to return, defaults to 1",
"schema": {
"description": "The page number to return, defaults to 1",
"type": "integer",
"format": "int64"
},
"style": "form"
},
{
"in": "query",
"name": "size",
"description": "The number of results per page, max 100",
"schema": {
"description": "The number of results per page, max 100",
"type": "integer",
"format": "int64"
},
"style": "form"
},
{
"in": "query",
"name": "start_date",
"description": "The earliest date for which data should be returned, formatted as YYYY-MM-DD",
"schema": {
"description": "The earliest date for which data should be returned, formatted as YYYY-MM-DD",
"type": "string"
},
"style": "form"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ListTransactionsResponse"
}
}
}
}
},
"security": [
{
"Secret API Key": [
"preview:bank_linking"
]
}
]
}
},
"/bank_links/{link_id}/transactions/sync": {
"get": {
"tags": [
"Users",
"BankLinking",
"PreviewTenantApi"
],
"description": "Provides a paginated feed of a link's transactions, grouped into created, updated, and removed lists. Each call will also return a cursor.next value. In subsequent calls, include that value to receive only changes that have occurred since the previous call. Note that these lists are unordered, so it is possible to get transactions with dates that precede those you've fetched in previous calls to this endpoint. Older transactions can be added, for example, when historical data becomes accessible later. Pending transactions will only be reported as created. Pending transactions are completely removed and replaced with each transaction refresh or update; no attempt is made to track their removal or modification. Pending transactions will not be reported in the removed list. If you store pending transactions, you should remove and replace them entirely each time you fetch new transactions. Large numbers of transactions will be paginated, and the has_more field will be true. You should continue calling this endpoint with each new cursor.next value until has_more is false. Note that this endpoint does not trigger a fetch of transactions from the institution; it merely returns transactions that have already been fetched, either because prefetch was requested when the link was created, or because of scheduled or on-demand updates. MoneyKit checks for updated account data, including transactions, periodically throughout the day, but the update frequency can vary, depending on the downstream data provider, the institution, and whether one or both provide webhook-based updates. To force a check for updated transactions, you can use the data_refresh endpoint. Note also that a webhook will alert you when new data is available.",
"parameters": [
{
"in": "path",
"name": "link_id",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
},
{
"in": "query",
"name": "cursor",
"description": "A cursor value representing the last update requested. If included, the response will\n only return changes after this update. If omitted, a complete history of updates will be\n returned. This value must be stored by you.",
"schema": {
"description": "A cursor value representing the last update requested. If included, the response will\n only return changes after this update. If omitted, a complete history of updates will be\n returned. This value must be stored by you.",
"type": "string"
},
"style": "form"
},
{
"in": "query",
"name": "size",
"description": "The number of results to return",
"schema": {
"description": "The number of results to return",
"type": "integer",
"format": "int64"
},
"style": "form"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TransactionsSyncResponse"
}
}
}
}
},
"security": [
{
"Secret API Key": [
"preview:bank_linking"
]
}
]
}
},
"/businesses": {
"get": {
"tags": [
"Businesses",
"PreviewTenantApi",
"HideWhenLocked"
],
"description": "Look up businesses based on external ID. This API is not intended to be used to paginate through all of your organization's businesses.",
"parameters": [
{
"in": "query",
"name": "cursor",
"schema": {
"example": null,
"type": "integer",
"format": "int64"
},
"style": "form"
},
{
"in": "query",
"name": "page_size",
"schema": {
"example": 10,
"type": "integer",
"format": "int64"
},
"style": "form"
},
{
"in": "query",
"name": "external_id",
"description": "Filter users by an external id",
"schema": {
"description": "Filter users by an external id",
"type": "string"
},
"style": "form"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CursorPaginatedLiteUser"
}
}
}
}
},
"security": [
{
"Secret API Key": [
"preview:legacy_list_users_businesses"
]
}
]
},
"post": {
"tags": [
"Businesses",
"Vault",
"PublicTenantApi"
],
"description": "Creates a new business vault, optionally initializing with the provided data",
"parameters": [
{
"in": "header",
"name": "x-sandbox-id",
"description": "When provided, creates a sandbox user with the provided sandbox ID. Sandbox IDs allow you to create multiple users with the same contact info. In order to log in using an existing sandbox user, you can provide its Sandbox ID in the Footprint flow.\n ",
"schema": {
"type": "string"
},
"style": "simple"
},
{
"in": "header",
"name": "x-external-id",
"description": "Optionally, this user's identifier in your own database. This will be associated with the user as their `external_id`, which is may be used in the future to look up a user in Footprint using your own user identifier. `x-external-id` must be globally unique to your organization. Can only be composed of alphanumeric characters, underscores, hyphens, and periods. Note, if `x-external-id` is provided, initial data may not be specified in the HTTP body.",
"schema": {
"type": "string"
},
"style": "simple"
}
],
"requestBody": {
"description": "Key-value map of data to add to the business's vault. For more documentation on available keys, see [here](https://docs.onefootprint.com/articles/vault/fields).",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RawBusinessDataRequest"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"headers": {
"x-fp-vault-version": {
"description": "The resulting version of the vault after applying any updates in this request.",
"style": "simple",
"content": {},
"x_fp_preview_gate": "vault_versioning"
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LiteUser"
}
}
}
}
},
"security": [
{
"Secret API Key": []
}
]
}
},
"/businesses/{fp_bid}": {
"get": {
"tags": [
"Businesses",
"PublicTenantApi",
"SupportsExternalId"
],
"description": "View basic details for a business. See the APIs under `/businesses/{fp_bid}/vault` for information on reading vault data.",
"parameters": [
{
"in": "path",
"name": "fp_bid",
"required": true,
"schema": {
"type": "string",
"pattern": "(fp_[_A-Za-z0-9]*)|(ext_id:[_A-Za-z0-9-]*)"
},
"style": "simple"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Business"
}
}
}
}
},
"security": [
{
"Secret API Key": []
}
]
},
"patch": {
"tags": [
"Businesses",
"Vault",
"PublicTenantApi",
"SupportsExternalId"
],
"parameters": [
{
"in": "path",
"name": "fp_bid",
"required": true,
"schema": {
"type": "string",
"pattern": "(fp_[_A-Za-z0-9]*)|(ext_id:[_A-Za-z0-9-]*)"
},
"style": "simple"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateEntityRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LiteUser"
}
}
}
}
},
"security": [
{
"Secret API Key": []
}
],
"description": ""
}
},
"/businesses/{fp_bid}/owners": {
"get": {
"tags": [
"Businesses",
"PublicTenantApi",
"SupportsExternalId"
],
"description": "Gets the beneficial owners of a business.",
"parameters": [
{
"in": "path",
"name": "fp_bid",
"required": true,
"schema": {
"type": "string",
"pattern": "(fp_[_A-Za-z0-9]*)|(ext_id:[_A-Za-z0-9-]*)"
},
"style": "simple"
},
{
"in": "query",
"name": "page",
"schema": {
"type": "integer",
"format": "int64"
},
"style": "form"
},
{
"in": "query",
"name": "page_size",
"schema": {
"type": "integer",
"format": "int64"
},
"style": "form"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OffsetPaginatedBusinessOwner"
}
}
}
}
},
"security": [
{
"Secret API Key": []
}
]
},
"post": {
"tags": [
"Businesses",
"PublicTenantApi",
"SupportsExternalId"
],
"description": "Link an existing fp_id to the provided business as a beneficial owner.",
"parameters": [
{
"in": "path",
"name": "fp_bid",
"required": true,
"schema": {
"type": "string",
"pattern": "(fp_[_A-Za-z0-9]*)|(ext_id:[_A-Za-z0-9-]*)"
},
"style": "simple"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NewBusinessOwnerRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Empty"
}
}
}
}
},
"security": [
{
"Secret API Key": []
}
]
}
},
"/businesses/{fp_bid}/decisions": {
"get": {
"tags": [
"Businesses",
"PreviewTenantApi",
"SupportsExternalId"
],
"description": "Returns list of decisions made for this business in timestamp descending order. Includes both automated decisions made by running rules on a playbook and manual decisions made via dashboard users.",
"parameters": [
{
"in": "path",
"name": "fp_bid",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
},
{
"in": "query",
"name": "page",
"schema": {
"type": "integer",
"format": "int64"
},
"style": "form"
},
{
"in": "query",
"name": "page_size",
"schema": {
"type": "integer",
"format": "int64"
},
"style": "form"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OffsetPaginatedPublicOnboardingDecision"
}
}
}
}
},
"security": [
{
"Secret API Key": [
"preview:decisions_list"
]
}
]
}
},
"/businesses/{fp_bid}/documents": {
"get": {
"tags": [
"Businesses",
"PublicTenantApi",
"SupportsExternalId"
],
"description": "View the documents uploaded successfully by this business.",
"parameters": [
{
"in": "query",
"name": "onboarding_id",
"schema": {
"type": "string"
},
"style": "form"
},
{
"in": "path",
"name": "fp_bid",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PublicDocument"
}
}
}
}
}
},
"security": [
{
"Secret API Key": []
}
]
}
},
"/businesses/{fp_bid}/kyb": {
"post": {
"tags": [
"Businesses",
"PreviewTenantApi",
"SupportsExternalId"
],
"description": "For a user and business whose information have already been collected, runs the verification checks of the provided playbook. This will contact the identity and business verification vendors configured on your playbook and issue a decision using the rules defined on your playbook.",
"parameters": [
{
"in": "path",
"name": "fp_bid",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TriggerKybRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EntityValidateResponse"
}
}
}
}
},
"security": [
{
"Secret API Key": []
}
]
}
},
"/businesses/{fp_bid}/onboardings": {
"get": {
"tags": [
"Businesses",
"PublicTenantApi",
"SupportsExternalId"
],
"description": "Get the list of playbooks this business has onboarded onto, ordered by timestamp descending. If a business has onboarded onto one playbook multiple times, there will be multiple onboardings. Useful to find the status from onboarding onto a specific playbook.",
"parameters": [
{
"in": "query",
"name": "page",
"schema": {
"type": "integer",
"format": "int64"
},
"style": "form"
},
{
"in": "query",
"name": "page_size",
"schema": {
"type": "integer",
"format": "int64"
},
"style": "form"
},
{
"in": "path",
"name": "fp_bid",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OffsetPaginatedPublicOnboarding"
}
}
}
}
},
"security": [
{
"Secret API Key": []
}
]
}
},
"/businesses/{fp_bid}/onboardings/{id}": {
"get": {
"tags": [
"Businesses",
"PublicTenantApi",
"SupportsExternalId"
],
"description": "Fetch a specific onboarding for this user, by `onboarding_id` or `onboarding_external_id`. Returns details about a given onboarding",
"parameters": [
{
"in": "path",
"name": "fp_bid",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
},
{
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PublicOnboarding"
}
}
}
}
},
"security": [
{
"Secret API Key": []
}
]
}
},
"/businesses/{fp_bid}/onboardings/{onboarding_id}/details": {
"get": {
"tags": [
"Businesses",
"PreviewTenantApi",
"Locked"
],
"description": "Retrieve business insights for a given fp_bid and onboarding. Note this is a preview API and may change without notice.",
"parameters": [
{
"in": "path",
"name": "fp_bid",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
},
{
"in": "path",
"name": "onboarding_id",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BusinessInsights"
}
}
}
}
},
"security": [
{
"Secret API Key": [
"preview:business_insights_api"
]
}
]
}
},
"/businesses/{fp_bid}/onboardings/{onboarding_id}/risk_signals": {
"get": {
"tags": [
"Businesses",
"PublicTenantApi",
"SupportsExternalId"
],
"description": "Get the list of risk signals for a Footprint user and onboarding.",
"parameters": [
{
"in": "path",
"name": "fp_bid",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
},
{
"in": "path",
"name": "onboarding_id",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PublicRiskSignal"
}
}
}
}
}
},
"security": [
{
"Secret API Key": []
}
]
}
},
"/businesses/{fp_bid}/risk_signals": {
"get": {
"tags": [
"Businesses",
"PreviewTenantApi",
"SupportsExternalId"
],
"description": "Lists the risk signals for a Footprint user.",
"parameters": [
{
"in": "path",
"name": "fp_bid",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PublicRiskSignal"
}
}
}
}
}
},
"security": [
{
"Secret API Key": [
"preview:risk_signals_list"
]
}
]
}
},
"/businesses/{fp_bid}/vault": {
"get": {
"tags": [
"Businesses",
"Vault",
"PublicTenantApi",
"SupportsExternalId"
],
"description": "Returns information on which fields are present in the business vault.",
"parameters": [
{
"in": "path",
"name": "fp_bid",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
},
{
"in": "query",
"name": "fields",
"description": "Optionally, a comma-separated list of fields whose existence to check. For example,\n `business.name,business.website,custom.account_id`",
"schema": {
"description": "Optionally, a comma-separated list of fields whose existence to check. For example,\n `business.name,business.website,custom.account_id`",
"type": "array",
"items": {
"$ref": "#/components/schemas/BusinessDataIdentifier"
}
},
"style": "form"
},
{
"in": "header",
"name": "x-fp-vault-version",
"description": "When provided, specifies the vault version to use for the given request.",
"schema": {
"x_fp_preview_gate": "vault_versioning",
"type": "string"
},
"style": "simple"
}
],
"responses": {
"200": {
"description": "OK",
"headers": {
"x-fp-vault-version": {
"description": "The resulting version of the vault after applying any updates in this request.",
"style": "simple",
"content": {},
"x_fp_preview_gate": "vault_versioning"
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetBusinessVaultResponse"
}
}
}
}
},
"security": [
{
"Secret API Key": []
}
]
},
"delete": {
"tags": [
"Businesses",
"Vault",
"PublicTenantApi",
"SupportsExternalId"
],
"description": "Deletes the provided fields from the provided business vault.",
"parameters": [
{
"in": "path",
"name": "fp_bid",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BusinessDeleteRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"headers": {
"x-fp-vault-version": {
"description": "The resulting version of the vault after applying any updates in this request.",
"style": "simple",
"content": {},
"x_fp_preview_gate": "vault_versioning"
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BusinessDeleteResponse"
}
}
}
}
},
"security": [
{
"Secret API Key": []
}
]
},
"patch": {
"tags": [
"Businesses",
"Vault",
"PublicTenantApi",
"SupportsExternalId"
],
"description": "Updates data in a business vault.",
"parameters": [
{
"in": "path",
"name": "fp_bid",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
}
],
"requestBody": {
"description": "Key-value map of data to add to the business's vault. For more documentation on available keys, see [here](https://docs.onefootprint.com/articles/vault/fields).",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RawBusinessDataRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"headers": {
"x-fp-vault-version": {
"description": "The resulting version of the vault after applying any updates in this request.",
"style": "simple",
"content": {},
"x_fp_preview_gate": "vault_versioning"
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Empty"
}
}
}
}
},
"security": [
{
"Secret API Key": []
}
]
}
},
"/businesses/{fp_bid}/vault/decrypt": {
"post": {
"tags": [
"Businesses",
"Vault",
"PublicTenantApi",
"SupportsExternalId"
],
"description": "Decrypts the specified list of fields from the provided business vault.",
"parameters": [
{
"in": "path",
"name": "fp_bid",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
},
{
"in": "header",
"name": "x-fp-vault-version",
"description": "When provided, specifies the vault version to use for the given request.",
"schema": {
"x_fp_preview_gate": "vault_versioning",
"type": "string"
},
"style": "simple"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BusinessDecryptRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"headers": {
"x-fp-vault-version": {
"description": "The resulting version of the vault after applying any updates in this request.",
"style": "simple",
"content": {},
"x_fp_preview_gate": "vault_versioning"
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BusinessDecryptResponse"
}
}
}
}
},
"security": [
{
"Secret API Key": []
}
]
}
},
"/businesses/{fp_bid}/vault/validate": {
"post": {
"tags": [
"Businesses",
"Vault",
"PublicTenantApi",
"SupportsExternalId"
],
"description": "Checks if provided data is valid before adding it to the vault. Returns an HTTP 200 if there are no validation errors, or HTTP 400 with context describing validation errors if any.",
"parameters": [
{
"in": "path",
"name": "fp_bid",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
}
],
"requestBody": {
"description": "Key-value map of data to add to the business's vault. For more documentation on available keys, see [here](https://docs.onefootprint.com/articles/vault/fields).",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RawBusinessDataRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Empty"
}
}
}
}
},
"security": [
{
"Secret API Key": []
}
]
}
},
"/businesses/{fp_id}/label": {
"get": {
"tags": [
"Businesses",
"PublicTenantApi",
"SupportsExternalId"
],
"description": "View a business's label",
"parameters": [
{
"in": "path",
"name": "fp_id",
"required": true,
"schema": {
"type": "string",
"pattern": "(fp_[_A-Za-z0-9]*)|(ext_id:[_A-Za-z0-9-]*)"
},
"style": "simple"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UserLabel"
}
}
}
}
},
"security": [
{
"Secret API Key": []
}
]
},
"post": {
"tags": [
"Businesses",
"PublicTenantApi",
"SupportsExternalId"
],
"description": "Update a business's label",
"parameters": [
{
"in": "path",
"name": "fp_id",
"required": true,
"schema": {
"type": "string",
"pattern": "(fp_[_A-Za-z0-9]*)|(ext_id:[_A-Za-z0-9-]*)"
},
"style": "simple"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateLabelRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Empty"
}
}
}
}
},
"security": [
{
"Secret API Key": []
}
]
}
},
"/businesses/{fp_id}/tags": {
"get": {
"tags": [
"Businesses",
"PublicTenantApi",
"SupportsExternalId"
],
"description": "View a businesses's tags",
"parameters": [
{
"in": "path",
"name": "fp_id",
"required": true,
"schema": {
"type": "string",
"pattern": "(fp_[_A-Za-z0-9]*)|(ext_id:[_A-Za-z0-9-]*)"
},
"style": "simple"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/UserTag"
}
}
}
}
}
},
"security": [
{
"Secret API Key": []
}
]
},
"post": {
"tags": [
"Businesses",
"PublicTenantApi",
"SupportsExternalId"
],
"description": "Tag a businesses",
"parameters": [
{
"in": "path",
"name": "fp_id",
"required": true,
"schema": {
"type": "string",
"pattern": "(fp_[_A-Za-z0-9]*)|(ext_id:[_A-Za-z0-9-]*)"
},
"style": "simple"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateTagRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UserTag"
}
}
}
}
},
"security": [
{
"Secret API Key": []
}
]
}
},
"/businesses/{fp_id}/tags/{tag_id}": {
"delete": {
"tags": [
"Businesses",
"PublicTenantApi",
"SupportsExternalId"
],
"description": "Untag a businesses",
"parameters": [
{
"in": "path",
"name": "fp_id",
"required": true,
"schema": {
"type": "string",
"pattern": "(fp_[_A-Za-z0-9]*)|(ext_id:[_A-Za-z0-9-]*)"
},
"style": "simple"
},
{
"in": "path",
"name": "tag_id",
"required": true,
"schema": {
"type": "string",
"pattern": "tag_[_A-Za-z0-9]*"
},
"style": "simple"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Empty"
}
}
}
}
},
"security": [
{
"Secret API Key": []
}
]
}
},
"/entities/{fp_id}/vault/redact": {
"post": {
"tags": [
"Vault",
"Entities",
"PublicTenantApi",
"SupportsExternalId"
],
"description": "Works for either person or business entities. Redacts the provided fields from the vault.",
"parameters": [
{
"in": "path",
"name": "fp_id",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RedactRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Empty"
}
}
}
}
},
"security": [
{
"Secret API Key": []
}
]
}
},
"/onboarding/session": {
"post": {
"tags": [
"Onboarding",
"PublicTenantApi"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateOnboardingSessionRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateOnboardingSessionResponse"
}
}
}
}
},
"security": [
{
"Secret API Key": []
}
],
"description": ""
}
},
"/onboarding/session/run": {
"post": {
"tags": [
"Onboarding",
"PreviewTenantApi",
"HideWhenLocked"
],
"requestBody": {
"description": "Create an onboarding session that prompts the user to onboarding onto the specified playbook.",
"content": {
"application/json": {
"schema": {
"description": "Create an onboarding session that prompts the user to onboarding onto the specified playbook.",
"type": "object",
"properties": {
"consent": {
"example": null,
"description": "Optionally, context on any consent forms displayed to the user before launching the\n Footprint flow.",
"x_fp_preview_gate": "third_party_auth",
"x_fp_collapsed": true,
"type": "array",
"items": {
"$ref": "#/components/schemas/UserConsentContext"
}
},
"key": {
"type": "string"
},
"onboarding_external_id": {
"example": null,
"description": "By default, if no `onboarding_external_id` is provided, a user will only be allowed to\n onboard onto a playbook one time. Use `onboarding_external_id` to control onboarding\n idempotency and associate an onboarding with an event in your application.\n
\n For more information, see [here](https://docs.onefootprint.com/articles/integrate/onboarding-sessions#example-use-cases-onboarding-idempotency).\n
\n Footprint will look up previous onboardings onto this playbook. If there is a matching\n onboarding with the provided `onboarding_external_id` (or if no `onboarding_external_id`\n is provided), the matching onboarding's results will be reused and returned without\n allowing the user to edit their data, run any verification checks, or re-evalute rules.\n
\n If there is no matching onboarding, a new onboarding will be created and the user will be\n allowed to onboard as normal.",
"x_fp_collapsed": true,
"type": "string"
},
"third_party_auth": {
"allOf": [
{
"$ref": "#/components/schemas/ThirdPartyAuthInfo"
},
{
"example": null,
"description": "Optionally, information about OTP performed by your organization before launching the\n Footprint flow.",
"x_fp_preview_gate": "third_party_auth",
"x_fp_collapsed": true,
"type": "object"
}
]
},
"user_external_id": {
"example": "c0a801f2-7a97-4c0b-9b4c-4ac3e8b1e9a4",
"description": "This user's identifier in your own database. This is used as an idempotency ID.",
"type": "string"
}
},
"required": [
"key",
"user_external_id"
]
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OnboardingSessionRunResponse"
}
}
}
}
},
"security": [
{
"Secret API Key": [
"preview:onboarding_session_run"
]
}
],
"description": ""
}
},
"/onboarding/session/validate": {
"post": {
"tags": [
"Onboarding",
"PublicTenantApi"
],
"description": "After a user finishes an interactive Footprint onboarding flow through one of our SDKs, your application will be given a validation token. This API allows you to exchange that short-lived validation token for the long-lived `fp_id` of the user who finished the flow. This also returns some information about the flow that the user has completed.",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ValidateRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ValidateResponse"
}
}
}
}
},
"security": [
{
"Secret API Key": []
}
]
}
},
"/org/risk_signals": {
"get": {
"tags": [
"Org",
"PreviewTenantApi"
],
"description": "List all Footprint Risk Signals",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PublicRiskSignalDescription"
}
}
}
}
}
},
"security": [
{
"Secret API Key": []
}
]
}
},
"/users": {
"get": {
"tags": [
"Users",
"PreviewTenantApi",
"HideWhenLocked"
],
"description": "Look up users based on external ID. This API is not intended to be used to paginate through all of your organization's users. To search for users based on PII, use the `POST /users/search` API.",
"parameters": [
{
"in": "query",
"name": "cursor",
"schema": {
"example": null,
"type": "integer",
"format": "int64"
},
"style": "form"
},
{
"in": "query",
"name": "page_size",
"schema": {
"example": 10,
"type": "integer",
"format": "int64"
},
"style": "form"
},
{
"in": "query",
"name": "external_id",
"schema": {
"type": "string"
},
"style": "form"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CursorPaginatedLiteUser"
}
}
}
}
},
"security": [
{
"Secret API Key": [
"preview:legacy_list_users_businesses"
]
}
]
},
"post": {
"tags": [
"Users",
"Vault",
"PublicTenantApi"
],
"description": "Creates a new user, optionally initializing with the provided data",
"parameters": [
{
"in": "header",
"name": "x-sandbox-id",
"description": "When provided, creates a sandbox user with the provided sandbox ID. Sandbox IDs allow you to create multiple users with the same contact info. In order to log in using an existing sandbox user, you can provide its Sandbox ID in the Footprint flow.\n ",
"schema": {
"type": "string"
},
"style": "simple"
},
{
"in": "header",
"name": "x-external-id",
"description": "Optionally, this user's identifier in your own database. This will be associated with the user as their `external_id`, which is may be used in the future to look up a user in Footprint using your own user identifier. `x-external-id` must be globally unique to your organization. Can only be composed of alphanumeric characters, underscores, hyphens, and periods. Note, if `x-external-id` is provided, initial data may not be specified in the HTTP body.",
"schema": {
"type": "string"
},
"style": "simple"
}
],
"requestBody": {
"description": "Key-value map of data to add to the user's vault. For more documentation on available keys, see [here](https://docs.onefootprint.com/articles/vault/fields).",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RawUserDataRequest"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"headers": {
"x-fp-vault-version": {
"description": "The resulting version of the vault after applying any updates in this request.",
"style": "simple",
"content": {},
"x_fp_preview_gate": "vault_versioning"
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LiteUser"
}
}
}
}
},
"security": [
{
"Secret API Key": []
}
]
}
},
"/users/search": {
"post": {
"tags": [
"Users",
"PublicTenantApi"
],
"description": "Search users by fingerprinted PII.",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SearchUsersRequestBody"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CursorPaginatedLiteUser"
}
}
}
}
},
"security": [
{
"Secret API Key": []
}
]
}
},
"/users/vault": {
"patch": {
"tags": [
"ClientVaulting",
"Vault",
"Users",
"PublicTenantApi"
],
"description": "Updates data in a vault given a short-lived, entity-scoped client token.",
"parameters": [
{
"in": "header",
"name": "x-fp-authorization",
"description": "Short-lived client token issued by the `POST /users/{fp_id}/client_token` API.",
"required": true,
"schema": {
"example": "cttok_UxM6Vbvk2Rcy1gzcSuXgk3sj3L9I0pAnNH",
"type": "string"
},
"style": "simple"
}
],
"requestBody": {
"description": "Key-value map of data to add to the user's vault. For more documentation on available keys, see [here](https://docs.onefootprint.com/articles/vault/fields).",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RawUserDataRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"headers": {
"x-fp-vault-version": {
"description": "The resulting version of the vault after applying any updates in this request.",
"style": "simple",
"content": {},
"x_fp_preview_gate": "vault_versioning"
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Empty"
}
}
}
}
},
"security": []
}
},
"/users/vault/decrypt": {
"post": {
"tags": [
"ClientVaulting",
"Vault",
"Users",
"PublicTenantApi"
],
"description": "Decrypts the specified list of fields given a short-lived, entity-scoped client token",
"parameters": [
{
"in": "header",
"name": "x-fp-authorization",
"description": "Short-lived client token issued by the `POST /users/{fp_id}/client_token` API.",
"required": true,
"schema": {
"example": "cttok_UxM6Vbvk2Rcy1gzcSuXgk3sj3L9I0pAnNH",
"type": "string"
},
"style": "simple"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ClientDecryptRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UserDecryptResponse"
}
}
}
}
},
"security": []
}
},
"/users/vault/decrypt/{token}": {
"get": {
"tags": [
"ClientVaulting",
"Vault",
"Users",
"PublicTenantApi"
],
"description": "Decrypts and downloads the user's data as specified by the provided token.",
"parameters": [
{
"in": "path",
"name": "token",
"description": "Short-lived client token with `decrypt_download` permissions to download a single piece of vaulted data.",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
}
],
"responses": {},
"security": []
}
},
"/users/vault/validate": {
"post": {
"tags": [
"ClientVaulting",
"Vault",
"Users",
"PublicTenantApi"
],
"description": "Checks if provided data is valid before adding it to the vault given a short-lived, user-scoped client token. Returns an HTTP 200 if there are no validation errors, or HTTP 400 with context describing validation errors if any.",
"parameters": [
{
"in": "header",
"name": "x-fp-authorization",
"description": "Short-lived client token issued by the `POST /users/{fp_id}/client_token` API.",
"required": true,
"schema": {
"example": "cttok_UxM6Vbvk2Rcy1gzcSuXgk3sj3L9I0pAnNH",
"type": "string"
},
"style": "simple"
}
],
"requestBody": {
"description": "Key-value map of data to add to the user's vault. For more documentation on available keys, see [here](https://docs.onefootprint.com/articles/vault/fields).",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RawUserDataRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Empty"
}
}
}
}
},
"security": []
}
},
"/users/vault/{identifier}/upload": {
"post": {
"tags": [
"ClientVaulting",
"Vault",
"Users",
"PublicTenantApi",
"HideWhenLocked"
],
"description": "Updates data in a vault given a short-lived, entity-scoped client token.",
"parameters": [
{
"in": "path",
"name": "identifier",
"required": true,
"schema": {
"type": "string",
"enum": [
"id.first_name",
"id.middle_name",
"id.last_name",
"id.dob",
"id.ssn4",
"id.ssn9",
"id.address_line1",
"id.address_line2",
"id.city",
"id.state",
"id.zip",
"id.country",
"id.email",
"id.phone_number",
"id.us_legal_status",
"id.visa_kind",
"id.visa_expiration_date",
"id.nationality",
"id.citizenships",
"id.drivers_license_number",
"id.drivers_license_state",
"id.itin",
"id.us_tax_id",
"business.name",
"business.dba",
"business.website",
"business.phone_number",
"business.tin",
"business.address_line1",
"business.address_line2",
"business.city",
"business.state",
"business.zip",
"business.country",
"business.beneficial_owners.*.ownership_stake",
"business.beneficial_owners.*.id.first_name",
"business.beneficial_owners.*.id.last_name",
"business.beneficial_owners.*.id.phone_number",
"business.beneficial_owners.*.id.email",
"business.beneficial_owner_explanation_message",
"business.corporation_type",
"business.formation_state",
"business.formation_date",
"custom.*",
"investor_profile.employment_status",
"investor_profile.occupation",
"investor_profile.employer",
"investor_profile.annual_income",
"investor_profile.net_worth",
"investor_profile.investment_goals",
"investor_profile.risk_tolerance",
"investor_profile.declarations",
"investor_profile.brokerage_firm_employer",
"investor_profile.senior_executive_symbols",
"investor_profile.family_member_names",
"investor_profile.political_organization",
"investor_profile.funding_sources",
"document.id_card.front.image",
"document.id_card.front.latest_upload",
"document.id_card.front.mime_type",
"document.id_card.back.image",
"document.id_card.back.latest_upload",
"document.id_card.back.mime_type",
"document.id_card.selfie.image",
"document.id_card.selfie.latest_upload",
"document.id_card.selfie.mime_type",
"document.id_card.full_name",
"document.id_card.first_name",
"document.id_card.last_name",
"document.id_card.dob",
"document.id_card.gender",
"document.id_card.full_address",
"document.id_card.address_line1",
"document.id_card.city",
"document.id_card.state",
"document.id_card.country",
"document.id_card.postal_code",
"document.id_card.document_number",
"document.id_card.expires_at",
"document.id_card.issued_at",
"document.id_card.issuing_state",
"document.id_card.issuing_country",
"document.id_card.ref_number",
"document.id_card.nationality",
"document.id_card.curp",
"document.id_card.clave_de_elector",
"document.id_card.classified_document_type",
"document.id_card.curp_validation_response",
"document.id_card.samba_activity_history_response",
"document.id_card.us_issuing_state",
"document.drivers_license.front.image",
"document.drivers_license.front.latest_upload",
"document.drivers_license.front.mime_type",
"document.drivers_license.back.image",
"document.drivers_license.back.latest_upload",
"document.drivers_license.back.mime_type",
"document.drivers_license.selfie.image",
"document.drivers_license.selfie.latest_upload",
"document.drivers_license.selfie.mime_type",
"document.drivers_license.full_name",
"document.drivers_license.first_name",
"document.drivers_license.last_name",
"document.drivers_license.dob",
"document.drivers_license.gender",
"document.drivers_license.full_address",
"document.drivers_license.address_line1",
"document.drivers_license.city",
"document.drivers_license.state",
"document.drivers_license.country",
"document.drivers_license.postal_code",
"document.drivers_license.document_number",
"document.drivers_license.expires_at",
"document.drivers_license.issued_at",
"document.drivers_license.issuing_state",
"document.drivers_license.issuing_country",
"document.drivers_license.ref_number",
"document.drivers_license.nationality",
"document.drivers_license.curp",
"document.drivers_license.clave_de_elector",
"document.drivers_license.classified_document_type",
"document.drivers_license.curp_validation_response",
"document.drivers_license.samba_activity_history_response",
"document.drivers_license.us_issuing_state",
"document.passport.front.image",
"document.passport.front.latest_upload",
"document.passport.front.mime_type",
"document.passport.back.image",
"document.passport.back.latest_upload",
"document.passport.back.mime_type",
"document.passport.selfie.image",
"document.passport.selfie.latest_upload",
"document.passport.selfie.mime_type",
"document.passport.full_name",
"document.passport.first_name",
"document.passport.last_name",
"document.passport.dob",
"document.passport.gender",
"document.passport.full_address",
"document.passport.address_line1",
"document.passport.city",
"document.passport.state",
"document.passport.country",
"document.passport.postal_code",
"document.passport.document_number",
"document.passport.expires_at",
"document.passport.issued_at",
"document.passport.issuing_state",
"document.passport.issuing_country",
"document.passport.ref_number",
"document.passport.nationality",
"document.passport.curp",
"document.passport.clave_de_elector",
"document.passport.classified_document_type",
"document.passport.curp_validation_response",
"document.passport.samba_activity_history_response",
"document.passport.us_issuing_state",
"document.passport_card.front.image",
"document.passport_card.front.latest_upload",
"document.passport_card.front.mime_type",
"document.passport_card.back.image",
"document.passport_card.back.latest_upload",
"document.passport_card.back.mime_type",
"document.passport_card.selfie.image",
"document.passport_card.selfie.latest_upload",
"document.passport_card.selfie.mime_type",
"document.passport_card.full_name",
"document.passport_card.first_name",
"document.passport_card.last_name",
"document.passport_card.dob",
"document.passport_card.gender",
"document.passport_card.full_address",
"document.passport_card.address_line1",
"document.passport_card.city",
"document.passport_card.state",
"document.passport_card.country",
"document.passport_card.postal_code",
"document.passport_card.document_number",
"document.passport_card.expires_at",
"document.passport_card.issued_at",
"document.passport_card.issuing_state",
"document.passport_card.issuing_country",
"document.passport_card.ref_number",
"document.passport_card.nationality",
"document.passport_card.curp",
"document.passport_card.clave_de_elector",
"document.passport_card.classified_document_type",
"document.passport_card.curp_validation_response",
"document.passport_card.samba_activity_history_response",
"document.passport_card.us_issuing_state",
"document.permit.front.image",
"document.permit.front.latest_upload",
"document.permit.front.mime_type",
"document.permit.back.image",
"document.permit.back.latest_upload",
"document.permit.back.mime_type",
"document.permit.selfie.image",
"document.permit.selfie.latest_upload",
"document.permit.selfie.mime_type",
"document.permit.full_name",
"document.permit.first_name",
"document.permit.last_name",
"document.permit.dob",
"document.permit.gender",
"document.permit.full_address",
"document.permit.address_line1",
"document.permit.city",
"document.permit.state",
"document.permit.country",
"document.permit.postal_code",
"document.permit.document_number",
"document.permit.expires_at",
"document.permit.issued_at",
"document.permit.issuing_state",
"document.permit.issuing_country",
"document.permit.ref_number",
"document.permit.nationality",
"document.permit.curp",
"document.permit.clave_de_elector",
"document.permit.classified_document_type",
"document.permit.curp_validation_response",
"document.permit.samba_activity_history_response",
"document.permit.us_issuing_state",
"document.visa.front.image",
"document.visa.front.latest_upload",
"document.visa.front.mime_type",
"document.visa.back.image",
"document.visa.back.latest_upload",
"document.visa.back.mime_type",
"document.visa.selfie.image",
"document.visa.selfie.latest_upload",
"document.visa.selfie.mime_type",
"document.visa.full_name",
"document.visa.first_name",
"document.visa.last_name",
"document.visa.dob",
"document.visa.gender",
"document.visa.full_address",
"document.visa.address_line1",
"document.visa.city",
"document.visa.state",
"document.visa.country",
"document.visa.postal_code",
"document.visa.document_number",
"document.visa.expires_at",
"document.visa.issued_at",
"document.visa.issuing_state",
"document.visa.issuing_country",
"document.visa.ref_number",
"document.visa.nationality",
"document.visa.curp",
"document.visa.clave_de_elector",
"document.visa.classified_document_type",
"document.visa.curp_validation_response",
"document.visa.samba_activity_history_response",
"document.visa.us_issuing_state",
"document.residence_document.front.image",
"document.residence_document.front.latest_upload",
"document.residence_document.front.mime_type",
"document.residence_document.back.image",
"document.residence_document.back.latest_upload",
"document.residence_document.back.mime_type",
"document.residence_document.selfie.image",
"document.residence_document.selfie.latest_upload",
"document.residence_document.selfie.mime_type",
"document.residence_document.full_name",
"document.residence_document.first_name",
"document.residence_document.last_name",
"document.residence_document.dob",
"document.residence_document.gender",
"document.residence_document.full_address",
"document.residence_document.address_line1",
"document.residence_document.city",
"document.residence_document.state",
"document.residence_document.country",
"document.residence_document.postal_code",
"document.residence_document.document_number",
"document.residence_document.expires_at",
"document.residence_document.issued_at",
"document.residence_document.issuing_state",
"document.residence_document.issuing_country",
"document.residence_document.ref_number",
"document.residence_document.nationality",
"document.residence_document.curp",
"document.residence_document.clave_de_elector",
"document.residence_document.classified_document_type",
"document.residence_document.curp_validation_response",
"document.residence_document.samba_activity_history_response",
"document.residence_document.us_issuing_state",
"document.voter_identification.front.image",
"document.voter_identification.front.latest_upload",
"document.voter_identification.front.mime_type",
"document.voter_identification.back.image",
"document.voter_identification.back.latest_upload",
"document.voter_identification.back.mime_type",
"document.voter_identification.selfie.image",
"document.voter_identification.selfie.latest_upload",
"document.voter_identification.selfie.mime_type",
"document.voter_identification.full_name",
"document.voter_identification.first_name",
"document.voter_identification.last_name",
"document.voter_identification.dob",
"document.voter_identification.gender",
"document.voter_identification.full_address",
"document.voter_identification.address_line1",
"document.voter_identification.city",
"document.voter_identification.state",
"document.voter_identification.country",
"document.voter_identification.postal_code",
"document.voter_identification.document_number",
"document.voter_identification.expires_at",
"document.voter_identification.issued_at",
"document.voter_identification.issuing_state",
"document.voter_identification.issuing_country",
"document.voter_identification.ref_number",
"document.voter_identification.nationality",
"document.voter_identification.curp",
"document.voter_identification.clave_de_elector",
"document.voter_identification.classified_document_type",
"document.voter_identification.curp_validation_response",
"document.voter_identification.samba_activity_history_response",
"document.voter_identification.us_issuing_state",
"document.finra_compliance_letter",
"document.proof_of_address.image",
"document.ssn_card.image",
"document.custom.*",
"card.*.number",
"card.*.expiration",
"card.*.cvc",
"card.*.name",
"card.*.billing_address.zip",
"card.*.billing_address.country",
"card.*.expiration_month",
"card.*.expiration_year",
"card.*.number_last4",
"card.*.issuer",
"card.*.fingerprint",
"bank.*.name",
"bank.*.ach_routing_number",
"bank.*.ach_wire_routing_number",
"bank.*.ach_account_number",
"bank.*.ach_account_id",
"bank.*.account_type",
"bank.*.institution_id",
"bank.*.institution_name",
"bank.*.account_last4",
"bank.*.iban",
"bank.*.bic",
"bank.*.owners",
"bank.*.mk_link_id",
"bank.*.link_id",
"bank.*.closed",
"bank.*.fingerprint"
]
},
"style": "simple"
},
{
"in": "header",
"name": "x-fp-authorization",
"description": "Short-lived client token issued by the `POST /users/{fp_id}/client_token` API.",
"required": true,
"schema": {
"example": "cttok_UxM6Vbvk2Rcy1gzcSuXgk3sj3L9I0pAnNH",
"type": "string"
},
"style": "simple"
},
{
"in": "header",
"name": "content-type",
"description": "Specify the content type of the object like `application/json` or `image/png`",
"schema": {
"type": "string"
},
"style": "simple"
}
],
"requestBody": {
"description": "Raw body",
"content": {
"application/json": {
"schema": {
"example": "raw data",
"description": "Raw data.",
"type": "string"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Empty"
}
}
}
}
},
"security": []
}
},
"/users/{fp_id}": {
"get": {
"tags": [
"Users",
"PublicTenantApi",
"SupportsExternalId"
],
"description": "View basic details for a user. See the APIs under `/users/{fp_id}/vault` for information on reading vault data.",
"parameters": [
{
"in": "path",
"name": "fp_id",
"required": true,
"schema": {
"type": "string",
"pattern": "(fp_[_A-Za-z0-9]*)|(ext_id:[_A-Za-z0-9-]*)"
},
"style": "simple"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/User"
}
}
}
}
},
"security": [
{
"Secret API Key": []
}
]
},
"patch": {
"tags": [
"Users",
"Vault",
"PublicTenantApi",
"SupportsExternalId"
],
"parameters": [
{
"in": "path",
"name": "fp_id",
"required": true,
"schema": {
"type": "string",
"pattern": "(fp_[_A-Za-z0-9]*)|(ext_id:[_A-Za-z0-9-]*)"
},
"style": "simple"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateEntityRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LiteUser"
}
}
}
}
},
"security": [
{
"Secret API Key": []
}
],
"description": ""
}
},
"/users/{fp_id}/client_token": {
"post": {
"tags": [
"Users",
"PublicTenantApi",
"SupportsExternalId"
],
"description": "Create a short-lived token safe to pass to your client for operations to vault or decrypt data for this user.",
"parameters": [
{
"in": "path",
"name": "fp_id",
"required": true,
"schema": {
"type": "string",
"pattern": "(fp_[_A-Za-z0-9]*)|(ext_id:[_A-Za-z0-9-]*)"
},
"style": "simple"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateClientTokenRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateClientTokenResponse"
}
}
}
}
},
"security": [
{
"Secret API Key": []
}
]
}
},
"/users/{fp_id}/integrations/alpaca/account": {
"post": {
"tags": [
"Integrations",
"Alpaca",
"PublicTenantApi",
"SupportsExternalId"
],
"description": "Create an Alpaca account",
"parameters": [
{
"in": "path",
"name": "fp_id",
"required": true,
"schema": {
"type": "string",
"pattern": "(fp_[_A-Za-z0-9]*)|(ext_id:[_A-Za-z0-9-]*)"
},
"style": "simple"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AlpacaCreateAccountRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AlpacaCreateAccountResponse"
}
}
}
}
},
"security": [
{
"Secret API Key": []
}
]
}
},
"/users/{fp_id}/integrations/alpaca/cip": {
"post": {
"tags": [
"Integrations",
"Alpaca",
"PublicTenantApi",
"SupportsExternalId"
],
"description": "Forward CIP information to Alpaca",
"parameters": [
{
"in": "path",
"name": "fp_id",
"required": true,
"schema": {
"type": "string",
"pattern": "(fp_[_A-Za-z0-9]*)|(ext_id:[_A-Za-z0-9-]*)"
},
"style": "simple"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AlpacaCipRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AlpacaCipResponse"
}
}
}
}
},
"security": [
{
"Secret API Key": []
}
]
}
},
"/users/{fp_id}/label": {
"get": {
"tags": [
"Users",
"PublicTenantApi",
"SupportsExternalId"
],
"description": "View a user's label",
"parameters": [
{
"in": "path",
"name": "fp_id",
"required": true,
"schema": {
"type": "string",
"pattern": "(fp_[_A-Za-z0-9]*)|(ext_id:[_A-Za-z0-9-]*)"
},
"style": "simple"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UserLabel"
}
}
}
}
},
"security": [
{
"Secret API Key": []
}
]
},
"post": {
"tags": [
"Users",
"PublicTenantApi",
"SupportsExternalId"
],
"description": "Update a user's label",
"parameters": [
{
"in": "path",
"name": "fp_id",
"required": true,
"schema": {
"type": "string",
"pattern": "(fp_[_A-Za-z0-9]*)|(ext_id:[_A-Za-z0-9-]*)"
},
"style": "simple"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateLabelRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Empty"
}
}
}
}
},
"security": [
{
"Secret API Key": []
}
]
}
},
"/users/{fp_id}/statuses": {
"patch": {
"tags": [
"Users",
"PublicTenantApi",
"SupportsExternalId"
],
"description": "Update a user's status.",
"parameters": [
{
"in": "path",
"name": "fp_id",
"required": true,
"schema": {
"type": "string",
"pattern": "(fp_[_A-Za-z0-9]*)|(ext_id:[_A-Za-z0-9-]*)"
},
"style": "simple"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateUserStatusRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Empty"
}
}
}
}
},
"security": [
{
"Secret API Key": []
}
]
}
},
"/users/{fp_id}/tags": {
"get": {
"tags": [
"Users",
"PublicTenantApi",
"SupportsExternalId"
],
"description": "View a user's tags",
"parameters": [
{
"in": "path",
"name": "fp_id",
"required": true,
"schema": {
"type": "string",
"pattern": "(fp_[_A-Za-z0-9]*)|(ext_id:[_A-Za-z0-9-]*)"
},
"style": "simple"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/UserTag"
}
}
}
}
}
},
"security": [
{
"Secret API Key": []
}
]
},
"post": {
"tags": [
"Users",
"PublicTenantApi",
"SupportsExternalId"
],
"description": "Tag a user",
"parameters": [
{
"in": "path",
"name": "fp_id",
"required": true,
"schema": {
"type": "string",
"pattern": "(fp_[_A-Za-z0-9]*)|(ext_id:[_A-Za-z0-9-]*)"
},
"style": "simple"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateTagRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UserTag"
}
}
}
}
},
"security": [
{
"Secret API Key": []
}
]
}
},
"/users/{fp_id}/tags/{tag_id}": {
"delete": {
"tags": [
"Users",
"PublicTenantApi",
"SupportsExternalId"
],
"description": "Untag a user",
"parameters": [
{
"in": "path",
"name": "fp_id",
"required": true,
"schema": {
"type": "string",
"pattern": "(fp_[_A-Za-z0-9]*)|(ext_id:[_A-Za-z0-9-]*)"
},
"style": "simple"
},
{
"in": "path",
"name": "tag_id",
"required": true,
"schema": {
"type": "string",
"pattern": "tag_[_A-Za-z0-9]*"
},
"style": "simple"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Empty"
}
}
}
}
},
"security": [
{
"Secret API Key": []
}
]
}
},
"/users/{fp_id}/vault": {
"get": {
"tags": [
"Users",
"Vault",
"PublicTenantApi",
"SupportsExternalId"
],
"description": "Returns information on which fields are present in the user vault.",
"parameters": [
{
"in": "path",
"name": "fp_id",
"required": true,
"schema": {
"type": "string",
"pattern": "(fp_[_A-Za-z0-9]*)|(ext_id:[_A-Za-z0-9-]*)"
},
"style": "simple"
},
{
"in": "query",
"name": "fields",
"description": "Optionally, a comma-separated list of fields whose existence to check. For example,\n `id.first_name,id.ssn4,custom.account_id`",
"schema": {
"description": "Optionally, a comma-separated list of fields whose existence to check. For example,\n `id.first_name,id.ssn4,custom.account_id`",
"type": "array",
"items": {
"$ref": "#/components/schemas/UserDataIdentifier"
}
},
"style": "form"
},
{
"in": "header",
"name": "x-fp-vault-version",
"description": "When provided, specifies the vault version to use for the given request.",
"schema": {
"x_fp_preview_gate": "vault_versioning",
"type": "string"
},
"style": "simple"
}
],
"responses": {
"200": {
"description": "OK",
"headers": {
"x-fp-vault-version": {
"description": "The resulting version of the vault after applying any updates in this request.",
"style": "simple",
"content": {},
"x_fp_preview_gate": "vault_versioning"
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetUserVaultResponse"
}
}
}
}
},
"security": [
{
"Secret API Key": []
}
]
},
"delete": {
"tags": [
"Users",
"Vault",
"PublicTenantApi",
"SupportsExternalId"
],
"description": "Deletes the provided fields from the provided user vault.",
"parameters": [
{
"in": "path",
"name": "fp_id",
"required": true,
"schema": {
"type": "string",
"pattern": "(fp_[_A-Za-z0-9]*)|(ext_id:[_A-Za-z0-9-]*)"
},
"style": "simple"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeleteRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"headers": {
"x-fp-vault-version": {
"description": "The resulting version of the vault after applying any updates in this request.",
"style": "simple",
"content": {},
"x_fp_preview_gate": "vault_versioning"
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UserDeleteResponse"
}
}
}
}
},
"security": [
{
"Secret API Key": []
}
]
},
"patch": {
"tags": [
"Users",
"Vault",
"PublicTenantApi",
"SupportsExternalId"
],
"description": "Updates data in a user vault.",
"parameters": [
{
"in": "path",
"name": "fp_id",
"required": true,
"schema": {
"type": "string",
"pattern": "(fp_[_A-Za-z0-9]*)|(ext_id:[_A-Za-z0-9-]*)"
},
"style": "simple"
}
],
"requestBody": {
"description": "Key-value map of data to add to the user's vault. For more documentation on available keys, see [here](https://docs.onefootprint.com/articles/vault/fields).",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RawUserDataRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"headers": {
"x-fp-vault-version": {
"description": "The resulting version of the vault after applying any updates in this request.",
"style": "simple",
"content": {},
"x_fp_preview_gate": "vault_versioning"
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Empty"
}
}
}
}
},
"security": [
{
"Secret API Key": []
}
]
}
},
"/users/{fp_id}/vault/validate": {
"post": {
"tags": [
"Users",
"Vault",
"PublicTenantApi",
"SupportsExternalId"
],
"description": "Checks if provided data is valid before adding it to the vault. Returns an HTTP 200 if there are no validation errors, or HTTP 400 with context describing validation errors if any.",
"parameters": [
{
"in": "path",
"name": "fp_id",
"required": true,
"schema": {
"type": "string",
"pattern": "(fp_[_A-Za-z0-9]*)|(ext_id:[_A-Za-z0-9-]*)"
},
"style": "simple"
}
],
"requestBody": {
"description": "Key-value map of data to add to the user's vault. For more documentation on available keys, see [here](https://docs.onefootprint.com/articles/vault/fields).",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RawUserDataRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Empty"
}
}
}
}
},
"security": [
{
"Secret API Key": []
}
]
}
},
"/users/{fp_id}/vault/{identifier}/upload": {
"post": {
"tags": [
"Users",
"Vault",
"PublicTenantApi",
"SupportsExternalId"
],
"description": "Sets the contents of the provided identifier for the provided user vault to the HTTP request body. Supports fp_id or ext_id. Useful for uploading large objects.",
"parameters": [
{
"in": "path",
"name": "fp_id",
"required": true,
"schema": {
"type": "string",
"pattern": "(fp_[_A-Za-z0-9]*)|(ext_id:[_A-Za-z0-9-]*)"
},
"style": "simple"
},
{
"in": "path",
"name": "identifier",
"required": true,
"schema": {
"type": "string",
"enum": [
"id.first_name",
"id.middle_name",
"id.last_name",
"id.dob",
"id.ssn4",
"id.ssn9",
"id.address_line1",
"id.address_line2",
"id.city",
"id.state",
"id.zip",
"id.country",
"id.email",
"id.phone_number",
"id.us_legal_status",
"id.visa_kind",
"id.visa_expiration_date",
"id.nationality",
"id.citizenships",
"id.drivers_license_number",
"id.drivers_license_state",
"id.itin",
"id.us_tax_id",
"business.name",
"business.dba",
"business.website",
"business.phone_number",
"business.tin",
"business.address_line1",
"business.address_line2",
"business.city",
"business.state",
"business.zip",
"business.country",
"business.beneficial_owners.*.ownership_stake",
"business.beneficial_owners.*.id.first_name",
"business.beneficial_owners.*.id.last_name",
"business.beneficial_owners.*.id.phone_number",
"business.beneficial_owners.*.id.email",
"business.beneficial_owner_explanation_message",
"business.corporation_type",
"business.formation_state",
"business.formation_date",
"custom.*",
"investor_profile.employment_status",
"investor_profile.occupation",
"investor_profile.employer",
"investor_profile.annual_income",
"investor_profile.net_worth",
"investor_profile.investment_goals",
"investor_profile.risk_tolerance",
"investor_profile.declarations",
"investor_profile.brokerage_firm_employer",
"investor_profile.senior_executive_symbols",
"investor_profile.family_member_names",
"investor_profile.political_organization",
"investor_profile.funding_sources",
"document.id_card.front.image",
"document.id_card.front.latest_upload",
"document.id_card.front.mime_type",
"document.id_card.back.image",
"document.id_card.back.latest_upload",
"document.id_card.back.mime_type",
"document.id_card.selfie.image",
"document.id_card.selfie.latest_upload",
"document.id_card.selfie.mime_type",
"document.id_card.full_name",
"document.id_card.first_name",
"document.id_card.last_name",
"document.id_card.dob",
"document.id_card.gender",
"document.id_card.full_address",
"document.id_card.address_line1",
"document.id_card.city",
"document.id_card.state",
"document.id_card.country",
"document.id_card.postal_code",
"document.id_card.document_number",
"document.id_card.expires_at",
"document.id_card.issued_at",
"document.id_card.issuing_state",
"document.id_card.issuing_country",
"document.id_card.ref_number",
"document.id_card.nationality",
"document.id_card.curp",
"document.id_card.clave_de_elector",
"document.id_card.classified_document_type",
"document.id_card.curp_validation_response",
"document.id_card.samba_activity_history_response",
"document.id_card.us_issuing_state",
"document.drivers_license.front.image",
"document.drivers_license.front.latest_upload",
"document.drivers_license.front.mime_type",
"document.drivers_license.back.image",
"document.drivers_license.back.latest_upload",
"document.drivers_license.back.mime_type",
"document.drivers_license.selfie.image",
"document.drivers_license.selfie.latest_upload",
"document.drivers_license.selfie.mime_type",
"document.drivers_license.full_name",
"document.drivers_license.first_name",
"document.drivers_license.last_name",
"document.drivers_license.dob",
"document.drivers_license.gender",
"document.drivers_license.full_address",
"document.drivers_license.address_line1",
"document.drivers_license.city",
"document.drivers_license.state",
"document.drivers_license.country",
"document.drivers_license.postal_code",
"document.drivers_license.document_number",
"document.drivers_license.expires_at",
"document.drivers_license.issued_at",
"document.drivers_license.issuing_state",
"document.drivers_license.issuing_country",
"document.drivers_license.ref_number",
"document.drivers_license.nationality",
"document.drivers_license.curp",
"document.drivers_license.clave_de_elector",
"document.drivers_license.classified_document_type",
"document.drivers_license.curp_validation_response",
"document.drivers_license.samba_activity_history_response",
"document.drivers_license.us_issuing_state",
"document.passport.front.image",
"document.passport.front.latest_upload",
"document.passport.front.mime_type",
"document.passport.back.image",
"document.passport.back.latest_upload",
"document.passport.back.mime_type",
"document.passport.selfie.image",
"document.passport.selfie.latest_upload",
"document.passport.selfie.mime_type",
"document.passport.full_name",
"document.passport.first_name",
"document.passport.last_name",
"document.passport.dob",
"document.passport.gender",
"document.passport.full_address",
"document.passport.address_line1",
"document.passport.city",
"document.passport.state",
"document.passport.country",
"document.passport.postal_code",
"document.passport.document_number",
"document.passport.expires_at",
"document.passport.issued_at",
"document.passport.issuing_state",
"document.passport.issuing_country",
"document.passport.ref_number",
"document.passport.nationality",
"document.passport.curp",
"document.passport.clave_de_elector",
"document.passport.classified_document_type",
"document.passport.curp_validation_response",
"document.passport.samba_activity_history_response",
"document.passport.us_issuing_state",
"document.passport_card.front.image",
"document.passport_card.front.latest_upload",
"document.passport_card.front.mime_type",
"document.passport_card.back.image",
"document.passport_card.back.latest_upload",
"document.passport_card.back.mime_type",
"document.passport_card.selfie.image",
"document.passport_card.selfie.latest_upload",
"document.passport_card.selfie.mime_type",
"document.passport_card.full_name",
"document.passport_card.first_name",
"document.passport_card.last_name",
"document.passport_card.dob",
"document.passport_card.gender",
"document.passport_card.full_address",
"document.passport_card.address_line1",
"document.passport_card.city",
"document.passport_card.state",
"document.passport_card.country",
"document.passport_card.postal_code",
"document.passport_card.document_number",
"document.passport_card.expires_at",
"document.passport_card.issued_at",
"document.passport_card.issuing_state",
"document.passport_card.issuing_country",
"document.passport_card.ref_number",
"document.passport_card.nationality",
"document.passport_card.curp",
"document.passport_card.clave_de_elector",
"document.passport_card.classified_document_type",
"document.passport_card.curp_validation_response",
"document.passport_card.samba_activity_history_response",
"document.passport_card.us_issuing_state",
"document.permit.front.image",
"document.permit.front.latest_upload",
"document.permit.front.mime_type",
"document.permit.back.image",
"document.permit.back.latest_upload",
"document.permit.back.mime_type",
"document.permit.selfie.image",
"document.permit.selfie.latest_upload",
"document.permit.selfie.mime_type",
"document.permit.full_name",
"document.permit.first_name",
"document.permit.last_name",
"document.permit.dob",
"document.permit.gender",
"document.permit.full_address",
"document.permit.address_line1",
"document.permit.city",
"document.permit.state",
"document.permit.country",
"document.permit.postal_code",
"document.permit.document_number",
"document.permit.expires_at",
"document.permit.issued_at",
"document.permit.issuing_state",
"document.permit.issuing_country",
"document.permit.ref_number",
"document.permit.nationality",
"document.permit.curp",
"document.permit.clave_de_elector",
"document.permit.classified_document_type",
"document.permit.curp_validation_response",
"document.permit.samba_activity_history_response",
"document.permit.us_issuing_state",
"document.visa.front.image",
"document.visa.front.latest_upload",
"document.visa.front.mime_type",
"document.visa.back.image",
"document.visa.back.latest_upload",
"document.visa.back.mime_type",
"document.visa.selfie.image",
"document.visa.selfie.latest_upload",
"document.visa.selfie.mime_type",
"document.visa.full_name",
"document.visa.first_name",
"document.visa.last_name",
"document.visa.dob",
"document.visa.gender",
"document.visa.full_address",
"document.visa.address_line1",
"document.visa.city",
"document.visa.state",
"document.visa.country",
"document.visa.postal_code",
"document.visa.document_number",
"document.visa.expires_at",
"document.visa.issued_at",
"document.visa.issuing_state",
"document.visa.issuing_country",
"document.visa.ref_number",
"document.visa.nationality",
"document.visa.curp",
"document.visa.clave_de_elector",
"document.visa.classified_document_type",
"document.visa.curp_validation_response",
"document.visa.samba_activity_history_response",
"document.visa.us_issuing_state",
"document.residence_document.front.image",
"document.residence_document.front.latest_upload",
"document.residence_document.front.mime_type",
"document.residence_document.back.image",
"document.residence_document.back.latest_upload",
"document.residence_document.back.mime_type",
"document.residence_document.selfie.image",
"document.residence_document.selfie.latest_upload",
"document.residence_document.selfie.mime_type",
"document.residence_document.full_name",
"document.residence_document.first_name",
"document.residence_document.last_name",
"document.residence_document.dob",
"document.residence_document.gender",
"document.residence_document.full_address",
"document.residence_document.address_line1",
"document.residence_document.city",
"document.residence_document.state",
"document.residence_document.country",
"document.residence_document.postal_code",
"document.residence_document.document_number",
"document.residence_document.expires_at",
"document.residence_document.issued_at",
"document.residence_document.issuing_state",
"document.residence_document.issuing_country",
"document.residence_document.ref_number",
"document.residence_document.nationality",
"document.residence_document.curp",
"document.residence_document.clave_de_elector",
"document.residence_document.classified_document_type",
"document.residence_document.curp_validation_response",
"document.residence_document.samba_activity_history_response",
"document.residence_document.us_issuing_state",
"document.voter_identification.front.image",
"document.voter_identification.front.latest_upload",
"document.voter_identification.front.mime_type",
"document.voter_identification.back.image",
"document.voter_identification.back.latest_upload",
"document.voter_identification.back.mime_type",
"document.voter_identification.selfie.image",
"document.voter_identification.selfie.latest_upload",
"document.voter_identification.selfie.mime_type",
"document.voter_identification.full_name",
"document.voter_identification.first_name",
"document.voter_identification.last_name",
"document.voter_identification.dob",
"document.voter_identification.gender",
"document.voter_identification.full_address",
"document.voter_identification.address_line1",
"document.voter_identification.city",
"document.voter_identification.state",
"document.voter_identification.country",
"document.voter_identification.postal_code",
"document.voter_identification.document_number",
"document.voter_identification.expires_at",
"document.voter_identification.issued_at",
"document.voter_identification.issuing_state",
"document.voter_identification.issuing_country",
"document.voter_identification.ref_number",
"document.voter_identification.nationality",
"document.voter_identification.curp",
"document.voter_identification.clave_de_elector",
"document.voter_identification.classified_document_type",
"document.voter_identification.curp_validation_response",
"document.voter_identification.samba_activity_history_response",
"document.voter_identification.us_issuing_state",
"document.finra_compliance_letter",
"document.proof_of_address.image",
"document.ssn_card.image",
"document.custom.*",
"card.*.number",
"card.*.expiration",
"card.*.cvc",
"card.*.name",
"card.*.billing_address.zip",
"card.*.billing_address.country",
"card.*.expiration_month",
"card.*.expiration_year",
"card.*.number_last4",
"card.*.issuer",
"card.*.fingerprint",
"bank.*.name",
"bank.*.ach_routing_number",
"bank.*.ach_wire_routing_number",
"bank.*.ach_account_number",
"bank.*.ach_account_id",
"bank.*.account_type",
"bank.*.institution_id",
"bank.*.institution_name",
"bank.*.account_last4",
"bank.*.iban",
"bank.*.bic",
"bank.*.owners",
"bank.*.mk_link_id",
"bank.*.link_id",
"bank.*.closed",
"bank.*.fingerprint"
]
},
"style": "simple"
},
{
"in": "header",
"name": "content-type",
"description": "Specify the content type of the object like `application/json` or `image/png`",
"schema": {
"type": "string"
},
"style": "simple"
}
],
"requestBody": {
"description": "Raw body",
"content": {
"application/json": {
"schema": {
"example": "raw data",
"description": "Raw data.",
"type": "string"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Empty"
}
}
}
}
},
"security": [
{
"Secret API Key": []
}
]
}
},
"/users/{fp_id}/auth_events": {
"get": {
"tags": [
"Users",
"PhasedOutTenantApi",
"HideWhenLocked"
],
"description": "View a user's recent device insights",
"parameters": [
{
"in": "path",
"name": "fp_id",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
},
{
"in": "query",
"name": "page",
"schema": {
"type": "integer",
"format": "int64"
},
"style": "form"
},
{
"in": "query",
"name": "page_size",
"schema": {
"type": "integer",
"format": "int64"
},
"style": "form"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OffsetPaginatedPublicAuthEvent"
}
}
}
}
},
"security": [
{
"Secret API Key": [
"preview:auth_events_list"
]
}
]
}
},
"/users/{fp_id}/bank_links": {
"get": {
"tags": [
"Users",
"BankLinking",
"PreviewTenantApi",
"SupportsExternalId"
],
"description": "Fetch all links for a given user.",
"parameters": [
{
"in": "path",
"name": "fp_id",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ListLinksResponse"
}
}
}
}
},
"security": [
{
"Secret API Key": [
"preview:bank_linking"
]
}
]
}
},
"/users/{fp_id}/bank_links/import": {
"post": {
"tags": [
"Users",
"BankLinking",
"PreviewTenantApi",
"SupportsExternalId"
],
"description": "Import a bank account link from a third party provider for a given user. Note that the imported transaction data has a maximum size limit of 1MB, which corresponds very roughly to about 4000 transactions. The data is processed synchronously, so you can expect a delay of up to 10 seconds before the response is transmitted.",
"parameters": [
{
"in": "path",
"name": "fp_id",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ImportLinkRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Link"
}
}
}
}
},
"security": [
{
"Secret API Key": [
"preview:bank_linking"
]
}
]
}
},
"/users/{fp_id}/decisions": {
"get": {
"tags": [
"Users",
"PreviewTenantApi",
"SupportsExternalId"
],
"description": "Returns list of decisions made for this user in timestamp descending order. Includes both automated decisions made by running rules on a playbook and manual decisions made via dashboard users.",
"parameters": [
{
"in": "path",
"name": "fp_id",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
},
{
"in": "query",
"name": "page",
"schema": {
"type": "integer",
"format": "int64"
},
"style": "form"
},
{
"in": "query",
"name": "page_size",
"schema": {
"type": "integer",
"format": "int64"
},
"style": "form"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OffsetPaginatedPublicOnboardingDecision"
}
}
}
}
},
"security": [
{
"Secret API Key": [
"preview:decisions_list"
]
}
]
},
"post": {
"tags": [
"Users",
"PreviewTenantApi",
"SupportsExternalId"
],
"description": "Creates a new manual review decision for a user, overriding any previous decision and clearing any outstanding manual review.",
"parameters": [
{
"in": "path",
"name": "fp_id",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateUserDecisionRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Empty"
}
}
}
}
},
"security": [
{
"Secret API Key": [
"preview:create_user_decision"
]
}
]
}
},
"/users/{fp_id}/documents": {
"get": {
"tags": [
"Users",
"PublicTenantApi",
"SupportsExternalId"
],
"description": "View the documents uploaded successfully by this user.",
"parameters": [
{
"in": "query",
"name": "onboarding_id",
"schema": {
"type": "string"
},
"style": "form"
},
{
"in": "path",
"name": "fp_id",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PublicDocument"
}
}
}
}
}
},
"security": [
{
"Secret API Key": []
}
]
}
},
"/users/{fp_id}/documents/{document_id}/consent": {
"get": {
"tags": [
"PreviewTenantApi",
"Users",
"HideWhenLocked"
],
"description": "Get the consent for a document provided by a user.",
"parameters": [
{
"in": "path",
"name": "fp_id",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
},
{
"in": "path",
"name": "document_id",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PublicIdentityDocumentConsent"
}
}
}
}
},
"security": [
{
"Secret API Key": [
"preview:identity_document_consent"
]
}
]
}
},
"/users/{fp_id}/duplicates": {
"get": {
"tags": [
"Users",
"PreviewTenantApi",
"SupportsExternalId"
],
"description": "List users with duplicate attributes to the provided user.",
"parameters": [
{
"in": "path",
"name": "fp_id",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
},
{
"in": "query",
"name": "kinds",
"description": "Kind of duplicates to return. Defaults to all kinds if omitted.",
"schema": {
"description": "Kind of duplicates to return. Defaults to all kinds if omitted.",
"type": "string"
},
"style": "form"
},
{
"in": "query",
"name": "limit",
"description": "The maximum number of duplicates to return. Max is 100.",
"schema": {
"description": "The maximum number of duplicates to return. Max is 100.",
"type": "integer",
"format": "int64"
},
"style": "form"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PublicDuplicateFingerprint"
}
}
}
}
}
},
"security": [
{
"Secret API Key": [
"preview:list_duplicate_users"
]
}
]
}
},
"/users/{fp_id}/integrations/apex/cip_report": {
"post": {
"tags": [
"Integrations",
"Apex",
"PreviewTenantApi",
"SupportsExternalId"
],
"description": "Export CIP information for APEX as a JSON object",
"parameters": [
{
"in": "path",
"name": "fp_id",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApexCipReportRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApexCipSummaryResults"
}
}
}
}
},
"security": [
{
"Secret API Key": []
}
]
}
},
"/users/{fp_id}/kyc": {
"post": {
"tags": [
"Users",
"PreviewTenantApi",
"SupportsExternalId"
],
"description": "For a user whose information has already been collected, runs the verification checks of the provided playbook. This will contact the identity verification vendors configured on your playbook and issue a decision using the rules defined on your playbook.",
"parameters": [
{
"in": "path",
"name": "fp_id",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TriggerKycRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"headers": {
"x-fp-vault-version": {
"description": "The resulting version of the vault after applying any updates in this request.",
"style": "simple",
"content": {},
"x_fp_preview_gate": "vault_versioning"
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PostUsersKycResponse"
}
}
}
}
},
"security": [
{
"Secret API Key": []
}
]
}
},
"/users/{fp_id}/linked_bank_accounts": {
"get": {
"tags": [
"Users",
"BankLinking",
"PreviewTenantApi",
"SupportsExternalId"
],
"description": "Fetch accounts for a given user.",
"parameters": [
{
"in": "path",
"name": "fp_id",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ListAccountsResponse"
}
}
}
}
},
"security": [
{
"Secret API Key": [
"preview:bank_linking"
]
}
]
}
},
"/users/{fp_id}/linked_bank_transactions": {
"get": {
"tags": [
"Users",
"BankLinking",
"PreviewTenantApi",
"SupportsExternalId"
],
"description": "Fetch transactions across all bank links for a given user.",
"parameters": [
{
"in": "path",
"name": "fp_id",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
},
{
"in": "query",
"name": "account_ids",
"description": "An optional list of account IDs to filter the results (comma separated)",
"schema": {
"description": "An optional list of account IDs to filter the results (comma separated)",
"type": "array",
"items": {
"type": "string"
}
},
"style": "form"
},
{
"in": "query",
"name": "end_date",
"description": "The latest date for which data should be returned, formatted as YYYY-MM-DD",
"schema": {
"description": "The latest date for which data should be returned, formatted as YYYY-MM-DD",
"type": "string"
},
"style": "form"
},
{
"in": "query",
"name": "page",
"description": "The page number to return, defaults to 1",
"schema": {
"description": "The page number to return, defaults to 1",
"type": "integer",
"format": "int64"
},
"style": "form"
},
{
"in": "query",
"name": "size",
"description": "The number of results per page, max 100",
"schema": {
"description": "The number of results per page, max 100",
"type": "integer",
"format": "int64"
},
"style": "form"
},
{
"in": "query",
"name": "start_date",
"description": "The earliest date for which data should be returned, formatted as YYYY-MM-DD",
"schema": {
"description": "The earliest date for which data should be returned, formatted as YYYY-MM-DD",
"type": "string"
},
"style": "form"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ListTransactionsResponse"
}
}
}
}
},
"security": [
{
"Secret API Key": [
"preview:bank_linking"
]
}
]
}
},
"/users/{fp_id}/liveness": {
"get": {
"tags": [
"Users",
"PhasedOutTenantApi",
"HideWhenLocked"
],
"description": "Lists the liveness signals for the provided user. This API is deprecated in favor of the `auth_events` API.",
"parameters": [
{
"in": "path",
"name": "fp_id",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/LivenessEvent"
}
}
}
}
}
},
"security": [
{
"Secret API Key": [
"preview:liveness_list"
]
}
]
}
},
"/users/{fp_id}/match_signals": {
"get": {
"tags": [
"Users",
"PhasedOutTenantApi",
"HideWhenLocked"
],
"description": "Lists the match signals for the provided user. This API is deprecated.",
"parameters": [
{
"in": "path",
"name": "fp_id",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetFieldValidationResponse"
}
}
}
}
},
"security": [
{
"Secret API Key": [
"preview:match_signals_list"
]
}
]
}
},
"/users/{fp_id}/onboardings": {
"get": {
"tags": [
"Users",
"PublicTenantApi",
"SupportsExternalId"
],
"description": "Get the list of playbooks this user has onboarded onto, ordered by timestamp descending. If a user has onboarded onto one playbook multiple times, there will be multiple onboardings. Useful to find the status from onboarding onto a specific playbook.",
"parameters": [
{
"in": "query",
"name": "page",
"schema": {
"type": "integer",
"format": "int64"
},
"style": "form"
},
{
"in": "query",
"name": "page_size",
"schema": {
"type": "integer",
"format": "int64"
},
"style": "form"
},
{
"in": "path",
"name": "fp_id",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OffsetPaginatedPublicOnboarding"
}
}
}
}
},
"security": [
{
"Secret API Key": []
}
]
}
},
"/users/{fp_id}/onboardings/{id}": {
"get": {
"tags": [
"Users",
"PublicTenantApi",
"SupportsExternalId"
],
"description": "Fetch a specific onboarding for this user, by `onboarding_id` or `onboarding_external_id`. Returns details about a given onboarding",
"parameters": [
{
"in": "path",
"name": "fp_id",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
},
{
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PublicOnboarding"
}
}
}
}
},
"security": [
{
"Secret API Key": []
}
]
}
},
"/users/{fp_id}/onboardings/{id}/ai_context": {
"post": {
"tags": [
"Users",
"PreviewTenantApi",
"HideWhenLocked",
"SupportsExternalId"
],
"description": "Compose an unstructured JSON blob with context for an onboarding that can be passed into an LLM. NOTE: the response of this API may change without any prior warning. Do not deserialize the response into any structured type. Footprint will only guarantee that the response will be a valid JSON object.",
"parameters": [
{
"in": "path",
"name": "fp_id",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
},
{
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AiContextResponse"
}
}
}
}
},
"security": [
{
"Secret API Key": [
"preview:ai_context"
]
}
]
}
},
"/users/{fp_id}/onboardings/{id}/device_insights": {
"post": {
"tags": [
"Users",
"PreviewTenantApi",
"HideWhenLocked",
"SupportsExternalId"
],
"description": "Exposes device insights and fingerprints for a given onboarding",
"parameters": [
{
"in": "path",
"name": "fp_id",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
},
{
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeviceInsightsResponse"
}
}
}
}
},
"security": [
{
"Secret API Key": [
"preview:device_insights"
]
}
]
}
},
"/users/{fp_id}/onboardings/{onboarding_id}/risk_signals": {
"get": {
"tags": [
"Users",
"PublicTenantApi",
"SupportsExternalId"
],
"description": "Get the list of risk signals for a Footprint user and onboarding.",
"parameters": [
{
"in": "path",
"name": "fp_id",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
},
{
"in": "path",
"name": "onboarding_id",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PublicRiskSignal"
}
}
}
}
}
},
"security": [
{
"Secret API Key": []
}
]
}
},
"/users/{fp_id}/risk_signals": {
"get": {
"tags": [
"Users",
"PhasedOutTenantApi",
"HideWhenLocked"
],
"description": "Lists the risk signals for a Footprint user. This endpoint is deprecated, but will continue to be supported for current users. Please use the /users/{fp_id}/onboardings/{onboarding_id}/risk_signals endpoint instead.",
"parameters": [
{
"in": "path",
"name": "fp_id",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PublicRiskSignal"
}
}
}
}
}
},
"security": [
{
"Secret API Key": [
"preview:risk_signals_list"
]
}
]
}
},
"/users/{fp_id}/vault/decrypt": {
"post": {
"tags": [
"Users",
"Vault",
"PublicTenantApi",
"SupportsExternalId"
],
"description": "Decrypts the specified list of fields from the provided user vault.",
"parameters": [
{
"in": "header",
"name": "x-fp-vault-version",
"description": "When provided, specifies the vault version to use for the given request.",
"schema": {
"x_fp_preview_gate": "vault_versioning",
"type": "string"
},
"style": "simple"
},
{
"in": "path",
"name": "fp_id",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UserDecryptRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"headers": {
"x-fp-vault-version": {
"description": "The resulting version of the vault after applying any updates in this request.",
"style": "simple",
"content": {},
"x_fp_preview_gate": "vault_versioning"
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UserDecryptResponse"
}
}
}
}
},
"security": [
{
"Secret API Key": []
}
]
}
},
"/users/{fp_id}/vault/integrity": {
"post": {
"tags": [
"Users",
"Vault",
"PhasedOutTenantApi",
"HideWhenLocked"
],
"description": "Checks if provided data is valid before adding it to the vault.",
"parameters": [
{
"in": "path",
"name": "fp_id",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IntegrityRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IntegrityResponse"
}
}
}
}
},
"security": [
{
"Secret API Key": [
"preview:vault_integrity"
]
}
]
}
},
"/users/{fp_id}/vault/redact": {
"post": {
"tags": [
"Users",
"Vault",
"PublicTenantApi",
"SupportsExternalId"
],
"description": "Redacts the provided fields from the provided user vault.",
"parameters": [
{
"in": "path",
"name": "fp_id",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RedactRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Empty"
}
}
}
}
},
"security": [
{
"Secret API Key": []
}
]
}
},
"/vault_proxy/jit": {
"post": {
"tags": [
"VaultProxy",
"PublicTenantApi"
],
"description": "Invoke the vault proxy 'just-in-time' (JIT) to securely send and receive data to a target destination. Please contact support to enable this API.",
"parameters": [
{
"in": "header",
"name": "x-fp-proxy-target-url",
"description": "Target proxy destination URL.",
"required": true,
"schema": {
"example": "https://acmebankprocessor.com/api/process_transaction",
"type": "string"
},
"style": "simple"
},
{
"in": "header",
"name": "x-fp-proxy-method",
"description": "HTTP Method VERB for the proxy destination request (defaults to POST).",
"schema": {
"type": "string"
},
"style": "simple"
},
{
"in": "header",
"name": "x-fp-path-and-query",
"description": "Egress destination URL path and query string to append.",
"schema": {
"type": "string"
},
"style": "simple"
},
{
"in": "header",
"name": "x-fp-proxy-ingress-content-type",
"description": "Content-type for the proxy ingress.",
"schema": {
"type": "string"
},
"style": "simple"
},
{
"in": "header",
"name": "x-fp-proxy-access-reason",
"description": "Access reason for any egress decryption operations during the proxy request.",
"schema": {
"type": "string"
},
"style": "simple"
},
{
"in": "header",
"name": "x-fp-id",
"description": "When proxy requests are on behalf of a single footprint vault, you can omit the `fp_id_` prefix on token identifiers, and just use `id.x` or `custom.y` instead of `fp_id_xyz.id.x` or `fp_id_xyz.custom.y`. Similarly, if specifying proxy configuration ingress rules from a stored configuration the corresponding token must be assigned just-in-time via a headers. i.e: `x-fp-id: fp_id_abc`",
"schema": {
"type": "string"
},
"style": "simple"
},
{
"in": "header",
"name": "x-fp-vault-version",
"description": "The vault version number to use for decryption. Not applicable if the payload references multiple vaults.",
"schema": {
"x_fp_preview_gate": "vault_versioning",
"type": "string"
},
"style": "simple"
},
{
"in": "header",
"name": "x-fp-proxy-ingress-rule",
"description": "Configure one more ingress rules. For example: `x-fp-proxy-ingress-rule: fp_id_abc.custom.credit_card_number=$.data.card.number` or `x-fp-proxy-ingress-rule: fp_id_abc.custom.credit_card_exp=$.data.card.expiration`",
"schema": {
"type": "string"
},
"style": "simple"
},
{
"in": "header",
"name": "x-fp-proxy-fwd-",
"description": "Headers with this `x-fp-proxy-fwd-*` prefix are forwarded to the proxy egress, with the prefix stripped. For example `x-fp-proxy-fwd-MYHEADER: hello world` sends `MYHEADER: hello world` to the destination.",
"schema": {
"type": "string"
},
"style": "simple"
},
{
"in": "header",
"name": "x-fp-proxy-client-cert",
"description": "Base64 encoded PEM client certificate to use (required if using key).",
"schema": {
"type": "string"
},
"style": "simple"
},
{
"in": "header",
"name": "x-fp-proxy-client-key",
"description": "Base64 encoded PEM client key to use (required if using cert).",
"schema": {
"type": "string"
},
"style": "simple"
},
{
"in": "header",
"name": "x-fp-proxy-pin-cert",
"description": "Configure one or more base64 encoded PEM server certificates to validate and pin proxy destination TLS connections.",
"schema": {
"type": "string"
},
"style": "simple"
}
],
"requestBody": {
"description": "Request body to be used in the vault proxy. The body may contain any number of \"vault proxy tokens,\", which are hydrated with the decrypted data from provided users' vaults.",
"content": {
"application/json": {
"schema": {
"example": {
"name": "{{ fp_id_Ih14yI0tMugEe5kdpnC0cl.id.first_name | to_uppercase }} {{ fp_id_Ih14yI0tMugEe5kdpnC0cl.id.last_name | to_uppercase }}",
"dob": "{{ fp_id_Ih14yI0tMugEe5kdpnC0cl.id.dob }}"
},
"description": "Request body to be used in the vault proxy. The body may contain any number of \"vault proxy tokens,\", which are hydrated with the decrypted data from provided users' vaults.",
"type": "string"
}
}
},
"required": true
},
"responses": {},
"security": [
{
"Secret API Key": [
"preview:vault_proxy_jit"
]
}
]
}
},
"/vault_proxy/reflect": {
"post": {
"tags": [
"VaultProxy",
"PublicTenantApi"
],
"description": "Given a raw HTTP body, decrypts data tokens in place for up to 1000 users at a time. Can be used to generate reports or test payloads that will be sent using the vault proxy. Tokens use the same syntax as the vault proxy. More information on vault proxy tokens can be found [here](https://docs.onefootprint.com/articles/vault/proxy#basics-token-body-template-format).",
"parameters": [
{
"in": "header",
"name": "x-fp-id",
"description": "When reflect requests are on behalf of a single footprint vault, you can can omit the `fp_id_` prefix on token identifiers, and just use `id.x` or `custom.y` instead of `fp_id_xyz.id.x` or `fp_id_xyz.custom.y`.",
"schema": {
"type": "string"
},
"style": "simple"
},
{
"in": "header",
"name": "x-fp-vault-version",
"description": "The vault version number to use for decryption. Not applicable if the payload references multiple vaults.",
"schema": {
"x_fp_preview_gate": "vault_versioning",
"type": "string"
},
"style": "simple"
},
{
"in": "header",
"name": "x-fp-access-reason",
"description": "Access reason for any decryption operations during the reflection request",
"schema": {
"type": "string"
},
"style": "simple"
}
],
"requestBody": {
"description": "Request body to be used in the vault proxy. The body may contain any number of \"vault proxy tokens,\", which are hydrated with the decrypted data from provided users' vaults.",
"content": {
"application/json": {
"schema": {
"example": {
"name": "{{ fp_id_Ih14yI0tMugEe5kdpnC0cl.id.first_name | to_uppercase }} {{ fp_id_Ih14yI0tMugEe5kdpnC0cl.id.last_name | to_uppercase }}",
"dob": "{{ fp_id_Ih14yI0tMugEe5kdpnC0cl.id.dob }}"
},
"description": "Request body to be used in the vault proxy. The body may contain any number of \"vault proxy tokens,\", which are hydrated with the decrypted data from provided users' vaults.",
"type": "string"
}
}
},
"required": true
},
"responses": {},
"security": [
{
"Secret API Key": []
}
]
}
},
"/vault_proxy/{id}": {
"post": {
"tags": [
"VaultProxy",
"PublicTenantApi"
],
"description": "Invoke the vault proxy by configuration id to securely send and receive data to a target destination. Please contact support to enable this API.",
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
},
{
"in": "header",
"name": "x-fp-proxy-method",
"description": "HTTP Method VERB for the proxy destination request (defaults to POST).",
"schema": {
"type": "string"
},
"style": "simple"
},
{
"in": "header",
"name": "x-fp-path-and-query",
"description": "Egress destination URL path and query string to append.",
"schema": {
"type": "string"
},
"style": "simple"
},
{
"in": "header",
"name": "x-fp-proxy-ingress-content-type",
"description": "Content-type for the proxy ingress.",
"schema": {
"type": "string"
},
"style": "simple"
},
{
"in": "header",
"name": "x-fp-proxy-access-reason",
"description": "Access reason for any egress decryption operations during the proxy request.",
"schema": {
"type": "string"
},
"style": "simple"
},
{
"in": "header",
"name": "x-fp-id",
"description": "When proxy requests are on behalf of a single footprint vault, you can omit the `fp_id_` prefix on token identifiers, and just use `id.x` or `custom.y` instead of `fp_id_xyz.id.x` or `fp_id_xyz.custom.y`. Similarly, if specifying proxy configuration ingress rules from a stored configuration the corresponding token must be assigned just-in-time via a headers. i.e: `x-fp-id: fp_id_abc`",
"schema": {
"type": "string"
},
"style": "simple"
},
{
"in": "header",
"name": "x-fp-vault-version",
"description": "The vault version number to use for decryption. Not applicable if the payload references multiple vaults.",
"schema": {
"x_fp_preview_gate": "vault_versioning",
"type": "string"
},
"style": "simple"
},
{
"in": "header",
"name": "x-fp-proxy-ingress-rule",
"description": "Configure one more ingress rules. For example: `x-fp-proxy-ingress-rule: fp_id_abc.custom.credit_card_number=$.data.card.number` or `x-fp-proxy-ingress-rule: fp_id_abc.custom.credit_card_exp=$.data.card.expiration`",
"schema": {
"type": "string"
},
"style": "simple"
},
{
"in": "header",
"name": "x-fp-proxy-fwd-",
"description": "Headers with this `x-fp-proxy-fwd-*` prefix are forwarded to the proxy egress, with the prefix stripped. For example `x-fp-proxy-fwd-MYHEADER: hello world` sends `MYHEADER: hello world` to the destination.",
"schema": {
"type": "string"
},
"style": "simple"
},
{
"in": "header",
"name": "x-fp-proxy-client-cert",
"description": "Base64 encoded PEM client certificate to use (required if using key).",
"schema": {
"type": "string"
},
"style": "simple"
},
{
"in": "header",
"name": "x-fp-proxy-client-key",
"description": "Base64 encoded PEM client key to use (required if using cert).",
"schema": {
"type": "string"
},
"style": "simple"
},
{
"in": "header",
"name": "x-fp-proxy-pin-cert",
"description": "Configure one or more base64 encoded PEM server certificates to validate and pin proxy destination TLS connections.",
"schema": {
"type": "string"
},
"style": "simple"
}
],
"requestBody": {
"description": "Request body to be used in the vault proxy. The body may contain any number of \"vault proxy tokens,\", which are hydrated with the decrypted data from provided users' vaults.",
"content": {
"application/json": {
"schema": {
"example": {
"name": "{{ fp_id_Ih14yI0tMugEe5kdpnC0cl.id.first_name | to_uppercase }} {{ fp_id_Ih14yI0tMugEe5kdpnC0cl.id.last_name | to_uppercase }}",
"dob": "{{ fp_id_Ih14yI0tMugEe5kdpnC0cl.id.dob }}"
},
"description": "Request body to be used in the vault proxy. The body may contain any number of \"vault proxy tokens,\", which are hydrated with the decrypted data from provided users' vaults.",
"type": "string"
}
}
},
"required": true
},
"responses": {},
"security": [
{
"Secret API Key": [
"preview:vault_proxy"
]
}
]
}
},
"/webhooks/test": {
"post": {
"tags": [
"Org",
"PublicTenantApi"
],
"description": "Trigger a test webhook",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TestWebhookRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Empty"
}
}
}
}
},
"security": [
{
"Secret API Key": []
}
]
}
}
},
"components": {
"securitySchemes": {
"Secret API Key": {
"type": "apiKey",
"in": "header",
"name": "X-Footprint-Secret-Key",
"description": "Secret API key. You can create and view your API keys in the dashboard. This key should never be sent to your client and should be treated as a secret on your server."
}
},
"schemas": {
"Account": {
"type": "object",
"properties": {
"account_type": {
"allOf": [
{
"$ref": "#/components/schemas/BankAccountType"
},
{
"example": "depository.checking",
"description": "The account type",
"type": "object"
}
]
},
"balances": {
"allOf": [
{
"$ref": "#/components/schemas/AccountBalances"
},
{
"description": "The account balances",
"type": "object"
}
]
},
"closed": {
"example": false,
"description": "Whether the account is closed",
"type": "boolean"
},
"id": {
"example": "acc_12345678",
"description": "The account ID",
"type": "string"
},
"link_id": {
"example": "bal_x134ssf3rsdf",
"description": "The link id for which this account belongs to",
"type": "string"
},
"mask": {
"example": 1234,
"description": "The account mask",
"type": "string"
},
"name": {
"example": "Checking Account",
"description": "The account name",
"type": "string"
},
"nickname": {
"example": "My Main Checking",
"description": "The account nickname",
"type": "string"
}
},
"required": [
"account_type",
"id",
"link_id",
"name"
]
},
"AccountBalances": {
"type": "object",
"properties": {
"available": {
"example": "1200.00",
"description": "The available balance",
"type": "number",
"format": "double"
},
"balance_date": {
"example": "2023-05-15T14:30:00Z",
"description": "The date the balance was captured at",
"type": "string",
"format": "date-time"
},
"currency": {
"example": "USD",
"description": "The currency of the account (ISO-4217)",
"type": "string"
},
"current": {
"example": "1250.45",
"description": "The current balance",
"type": "number",
"format": "double"
},
"limit": {
"example": "2000.00",
"description": "The limit",
"type": "number",
"format": "double"
}
}
},
"Agreement": {
"description": "In order to comply with Alpaca\u2019s terms of service, each account owner must be presented the\n following agreements.",
"type": "object",
"properties": {
"agreement": {
"$ref": "#/components/schemas/AlpacaAgreements"
},
"ip_address": {
"type": "string"
},
"revision": {
"type": "string"
},
"signed_at": {
"description": "string (timestamp)",
"type": "string",
"format": "date-time"
}
},
"required": [
"agreement",
"ip_address",
"signed_at"
]
},
"AiContextResponse": {
"type": "object",
"properties": {
"screening_hits": {
"type": "object"
}
}
},
"AlpacaAccountType": {
"type": "string",
"enum": [
"trading",
"custodial",
"donor_advised"
]
},
"AlpacaAgreements": {
"type": "string",
"enum": [
"customer_agreement",
"crypto_agreement",
"account_agreement",
"margin_agreement",
"options_agreement",
"custodial_customer_agreement"
]
},
"AlpacaCipRequest": {
"type": "object",
"properties": {
"account_id": {
"description": "The associated user's alpaca account id",
"type": "string"
},
"api_key": {
"description": "API Key to use with alpaca",
"type": "string"
},
"api_secret": {
"description": "API Secret to use with alpaca",
"type": "string"
},
"default_approver": {
"description": "The default approver name/email to use for automatically approved users. This will be\n overwritten if done by a manual reviewer",
"type": "string"
},
"hostname": {
"description": "Alpaca Hostname to use (i.e. sandbox or production, like:\n `broker-api.sandbox.alpaca.markets`)",
"type": "string"
}
},
"required": [
"account_id",
"api_key",
"api_secret",
"default_approver",
"hostname"
]
},
"AlpacaCipResponse": {
"type": "object",
"properties": {
"alpaca_response": {
"allOf": [
{
"$ref": "#/components/schemas/PiiJsonValue"
},
{
"description": "Response body from Alpaca",
"type": "object"
}
]
},
"status_code": {
"example": 200,
"description": "HTTP status code from Alpaca response",
"type": "integer",
"format": "int32"
}
},
"required": [
"alpaca_response",
"status_code"
]
},
"AlpacaContextType": {
"type": "string",
"enum": [
"CONTROLLED_FIRM",
"AFFILIATE_FIRM",
"IMMEDIATE_FAMILY_EXPOSED"
]
},
"AlpacaCreateAccountRequest": {
"type": "object",
"properties": {
"account_type": {
"$ref": "#/components/schemas/AlpacaAccountType"
},
"agreements": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Agreement"
}
},
"api_key": {
"description": "API Key to use with alpaca",
"type": "string"
},
"api_secret": {
"description": "API Secret to use with alpaca",
"type": "string"
},
"disclosures": {
"$ref": "#/components/schemas/Disclosures"
},
"enabled_assets": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AssetClass"
}
},
"hostname": {
"description": "Alpaca Hostname to use (i.e. sandbox or production, like:\n `broker-api.sandbox.alpaca.markets`)",
"type": "string"
},
"trusted_contact": {
"$ref": "#/components/schemas/TrustedContact"
}
},
"required": [
"api_key",
"api_secret",
"hostname"
]
},
"AlpacaCreateAccountResponse": {
"type": "object",
"properties": {
"alpaca_response": {
"allOf": [
{
"$ref": "#/components/schemas/PiiJsonValue"
},
{
"description": "Response body from Alpaca",
"type": "object"
}
]
},
"status_code": {
"example": 200,
"description": "HTTP status code from Alpaca response",
"type": "integer",
"format": "int32"
}
},
"required": [
"alpaca_response",
"status_code"
]
},
"AlpacaEmploymentStatus": {
"type": "string",
"enum": [
"UNEMPLOYED",
"EMPLOYED",
"STUDENT",
"RETIRED"
]
},
"ApexCheckedKycData": {
"type": "object",
"properties": {
"address": {
"type": "string"
},
"customer_name": {
"type": "string"
},
"date_of_birth": {
"type": "string"
},
"tax_id": {
"type": "string"
}
},
"required": [
"address",
"customer_name",
"date_of_birth"
]
},
"ApexCipReportRequest": {
"type": "object",
"properties": {
"default_approver": {
"example": "janedoe@acmebank.org",
"description": "The default approver name/email to use for automatically approved users. This will be\n overwritten if done by a manual reviewer",
"type": "string"
}
},
"required": [
"default_approver"
]
},
"ApexCipResult": {
"type": "string",
"enum": [
"clear",
"consider"
]
},
"ApexCipSummaryResults": {
"type": "object",
"properties": {
"approved_at": {
"type": "string",
"format": "date-time"
},
"approved_by": {
"type": "string"
},
"approved_reason": {
"type": "string"
},
"check_completed_at": {
"type": "string",
"format": "date-time"
},
"check_initiated_at": {
"type": "string",
"format": "date-time"
},
"checked_data": {
"$ref": "#/components/schemas/ApexCheckedKycData"
},
"date_of_birth": {
"$ref": "#/components/schemas/ApexCipResult"
},
"date_of_birth_breakdown": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Vendor"
}
},
"ip_address": {
"type": "string"
},
"kyc_completed_at": {
"type": "string",
"format": "date-time"
},
"matched_address": {
"$ref": "#/components/schemas/ApexCipResult"
},
"matched_addresses": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Vendor"
}
},
"result": {
"$ref": "#/components/schemas/ApexCipResult"
},
"self_reported": {
"$ref": "#/components/schemas/ApexSelfReportedData"
},
"tax_id": {
"$ref": "#/components/schemas/ApexCipResult"
},
"tax_id_breakdown": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Vendor"
}
},
"user_id": {
"type": "string"
},
"watchlist": {
"$ref": "#/components/schemas/ApexWatchlist"
}
},
"required": [
"approved_at",
"approved_by",
"checked_data",
"date_of_birth",
"date_of_birth_breakdown",
"ip_address",
"matched_address",
"matched_addresses",
"result",
"self_reported",
"tax_id",
"tax_id_breakdown",
"user_id",
"watchlist"
]
},
"ApexSelfReportedData": {
"type": "object",
"properties": {
"annual_income": {
"type": "string"
},
"citizenships": {
"type": "string"
},
"declarations": {
"type": "string"
},
"employment_status": {
"type": "string"
},
"investment_objectives": {
"type": "string"
},
"is_employed_at_brokerage_firm": {
"type": "string"
},
"net_worth": {
"type": "string"
},
"occupation": {
"type": "string"
},
"us_legal_status": {
"type": "string"
},
"visa_kind": {
"type": "string"
}
}
},
"ApexWatchlist": {
"type": "object",
"properties": {
"adverse_media": {
"$ref": "#/components/schemas/ApexCipResult"
},
"check_completed_at": {
"type": "string",
"format": "date-time"
},
"monitored_lists": {
"$ref": "#/components/schemas/ApexCipResult"
},
"politically_exposed_person": {
"$ref": "#/components/schemas/ApexCipResult"
},
"records": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PiiJsonValue"
}
},
"result": {
"$ref": "#/components/schemas/ApexCipResult"
},
"sanction": {
"$ref": "#/components/schemas/ApexCipResult"
}
},
"required": [
"adverse_media",
"check_completed_at",
"monitored_lists",
"politically_exposed_person",
"records",
"result",
"sanction"
]
},
"AssetClass": {
"type": "string",
"enum": [
"us_equity",
"crypto"
]
},
"AuthEventKind": {
"type": "string",
"enum": [
"sms",
"email",
"passkey"
]
},
"AuthMethodKind": {
"type": "string",
"enum": [
"phone",
"passkey",
"email"
]
},
"BankAccountType": {
"description": "The bank account type.",
"anyOf": [
{
"description": "Cash management account",
"type": "string",
"enum": [
"depository.cash_management"
]
},
{
"description": "Certificate of deposit",
"type": "string",
"enum": [
"depository.cd"
]
},
{
"description": "Checking account",
"type": "string",
"enum": [
"depository.checking"
]
},
{
"description": "Electronic benefit transfer",
"type": "string",
"enum": [
"depository.ebt"
]
},
{
"description": "Guaranteed investment certificate (CA only)",
"type": "string",
"enum": [
"depository.gic"
]
},
{
"description": "Health savings account",
"type": "string",
"enum": [
"depository.hsa"
]
},
{
"description": "Individual savings account (GB only)",
"type": "string",
"enum": [
"depository.isa"
]
},
{
"description": "Money market account",
"type": "string",
"enum": [
"depository.money_market"
]
},
{
"description": "Prepaid card",
"type": "string",
"enum": [
"depository.prepaid"
]
},
{
"description": "Registered disability savings plan (CA only)",
"type": "string",
"enum": [
"depository.rdsp"
]
},
{
"description": "Registered education savings plan (CA only)",
"type": "string",
"enum": [
"depository.resp"
]
},
{
"description": "Registered retirement savings plan (CA only)",
"type": "string",
"enum": [
"depository.rrsp"
]
},
{
"description": "Savings account",
"type": "string",
"enum": [
"depository.savings"
]
},
{
"description": "Tax-free savings account (CA only)",
"type": "string",
"enum": [
"depository.tfsa"
]
},
{
"description": "401a retirement account",
"type": "string",
"enum": [
"investment.401a"
]
},
{
"description": "401k retirement account",
"type": "string",
"enum": [
"investment.401k"
]
},
{
"description": "403b retirement account",
"type": "string",
"enum": [
"investment.403b"
]
},
{
"description": "457b retirement account",
"type": "string",
"enum": [
"investment.457b"
]
},
{
"description": "529 college savings plan",
"type": "string",
"enum": [
"investment.529"
]
},
{
"description": "Brokerage account",
"type": "string",
"enum": [
"investment.brokerage"
]
},
{
"description": "Cryptocurrency account",
"type": "string",
"enum": [
"investment.crypto"
]
},
{
"description": "Education savings account",
"type": "string",
"enum": [
"investment.esa"
]
},
{
"description": "Employee stock purchase plan",
"type": "string",
"enum": [
"investment.espp"
]
},
{
"description": "IRA (individual retirement account)",
"type": "string",
"enum": [
"investment.ira"
]
},
{
"description": "Keogh plan",
"type": "string",
"enum": [
"investment.keogh"
]
},
{
"description": "Life income fund (CA only)",
"type": "string",
"enum": [
"investment.lif"
]
},
{
"description": "Locked-in retirement account (CA only)",
"type": "string",
"enum": [
"investment.lira"
]
},
{
"description": "Locked-in retirement fund (CA only)",
"type": "string",
"enum": [
"investment.lirf"
]
},
{
"description": "Locked-in retirement savings plan (CA only)",
"type": "string",
"enum": [
"investment.lrsp"
]
},
{
"description": "Restricted life income fund (CA only)",
"type": "string",
"enum": [
"investment.rlif"
]
},
{
"description": "Rollover IRA",
"type": "string",
"enum": [
"investment.rollover_ira"
]
},
{
"description": "Roth IRA",
"type": "string",
"enum": [
"investment.roth"
]
},
{
"description": "Roth 401k IRA",
"type": "string",
"enum": [
"investment.roth_401k"
]
},
{
"description": "Registered retirement income fund (CA only)",
"type": "string",
"enum": [
"investment.rrif"
]
},
{
"description": "SEP IRA (simplified employee pension plan)",
"type": "string",
"enum": [
"investment.sep_ira"
]
},
{
"description": "Simple IRA",
"type": "string",
"enum": [
"investment.simple_ira"
]
},
{
"description": "Self-invested personal pension (GB only)",
"type": "string",
"enum": [
"investment.sipp"
]
},
{
"description": "Stock plan",
"type": "string",
"enum": [
"investment.stock_plan"
]
},
{
"description": "Generic tax-deferred investment account",
"type": "string",
"enum": [
"investment.tax_deferred"
]
},
{
"description": "Thrift savings plan",
"type": "string",
"enum": [
"investment.thrift_savings_plan"
]
},
{
"description": "Trust",
"type": "string",
"enum": [
"investment.trust"
]
},
{
"description": "Uniform Gift to Minors Act",
"type": "string",
"enum": [
"investment.ugma"
]
},
{
"description": "Uniform Transfer to Minors Act",
"type": "string",
"enum": [
"investment.utma"
]
},
{
"description": "Credit card",
"type": "string",
"enum": [
"liability.credit_card"
]
},
{
"description": "Home equity loan",
"type": "string",
"enum": [
"liability.home_equity"
]
},
{
"description": "Line of credit",
"type": "string",
"enum": [
"liability.line_of_credit"
]
},
{
"description": "Loan",
"type": "string",
"enum": [
"liability.loan"
]
},
{
"description": "Mortgage",
"type": "string",
"enum": [
"liability.mortgage"
]
},
{
"description": "Student loan",
"type": "string",
"enum": [
"liability.student_loan"
]
},
{
"description": "Annuity",
"type": "string",
"enum": [
"other.annuity"
]
},
{
"description": "Insurance policy",
"type": "string",
"enum": [
"other.insurance"
]
},
{
"description": "Life insurance policy",
"type": "string",
"enum": [
"other.life_insurance"
]
},
{
"description": "Payroll",
"type": "string",
"enum": [
"other.payroll"
]
},
{
"description": "Pension",
"type": "string",
"enum": [
"other.pension"
]
},
{
"description": "Profit sharing plan",
"type": "string",
"enum": [
"other.profit_sharing_plan"
]
},
{
"description": "Rewards account",
"type": "string",
"enum": [
"other.rewards"
]
},
{
"type": "object",
"properties": {
"Unknown": {
"description": "Unknown account type",
"type": "string"
}
},
"required": [
"Unknown"
]
}
]
},
"BankLinkError": {
"anyOf": [
{
"type": "string",
"enum": [
"system_error"
]
},
{
"type": "string",
"enum": [
"provider_error"
]
},
{
"type": "string",
"enum": [
"institution_error"
]
},
{
"type": "string",
"enum": [
"user_error"
]
},
{
"type": "string",
"enum": [
"auth_expired"
]
},
{
"type": "string",
"enum": [
"no_accounts"
]
},
{
"type": "string",
"enum": [
"user_setup_required"
]
},
{
"type": "string",
"enum": [
"invalid_credentials"
]
},
{
"type": "string",
"enum": [
"user_oauth_denied"
]
},
{
"type": "string",
"enum": [
"user_input_incorrect"
]
},
{
"type": "string",
"enum": [
"incomplete"
]
},
{
"type": "object",
"properties": {
"other": {
"type": "string"
}
},
"required": [
"other"
]
}
]
},
"BankLinkProduct": {
"anyOf": [
{
"type": "string",
"enum": [
"accounts"
]
},
{
"type": "string",
"enum": [
"account_numbers"
]
},
{
"type": "string",
"enum": [
"transactions"
]
},
{
"type": "string",
"enum": [
"investments"
]
},
{
"type": "string",
"enum": [
"identity"
]
},
{
"type": "string",
"enum": [
"enrichment"
]
},
{
"type": "object",
"properties": {
"other": {
"type": "string"
}
},
"required": [
"other"
]
}
]
},
"BankLinkState": {
"anyOf": [
{
"type": "string",
"enum": [
"connecting"
]
},
{
"type": "string",
"enum": [
"awaiting_token_exchange"
]
},
{
"type": "string",
"enum": [
"connected"
]
},
{
"type": "string",
"enum": [
"deleted"
]
},
{
"type": "string",
"enum": [
"error"
]
},
{
"type": "object",
"properties": {
"other": {
"type": "string"
}
},
"required": [
"other"
]
}
]
},
"BankLinkUpdateKind": {
"type": "string",
"enum": [
"link_state_changed",
"link_product_refreshed",
"transaction_update_available"
]
},
"BankLinkingConfig": {
"type": "object",
"properties": {
"allowed_institutions": {
"example": [
"bofa",
"chase"
],
"description": "A list of Institution IDs, if provided, will be used to limit connection options.",
"type": "array",
"items": {
"type": "string"
}
},
"blocked_institutions": {
"example": [
"venmo",
"chime"
],
"description": "A list of Institution IDs, if provided, will be blocked from being selected by the user.",
"type": "array",
"items": {
"type": "string"
}
},
"connect_features": {
"example": null,
"description": "Features object for the bank account linking widget",
"type": "object"
},
"create_intent_only": {
"example": false,
"description": "If true, will only create a `bank link intent` and not a bank link.\n Once the onboarding session is completed, you will get back a `bank_link_intent_id`\n that can be used to create a bank link via the `POST /bank_links` endpoint.",
"type": "boolean"
},
"existing_link_id": {
"example": null,
"description": "The existing link ID to use for re-linking.",
"type": "string"
},
"institution_id": {
"example": null,
"description": "If specified, restricts to a single institution.",
"type": "string"
},
"link_settings": {
"allOf": [
{
"$ref": "#/components/schemas/BankLinkingLinkSettings"
},
{
"example": {
"required_products": [
"account_numbers",
"transactions"
]
},
"description": "Settings for what type of bank account link to create",
"type": "object"
}
]
}
}
},
"BankLinkingLinkSettings": {
"type": "object",
"properties": {
"additional_products": {
"description": "Additional products to add to the bank account link (if any)\n If omitted, no additional products will be added\n If the link doesn't support them, they won't be added",
"type": "array",
"items": {
"$ref": "#/components/schemas/BankLinkingProduct"
}
},
"fetch_immediately": {
"description": "Immediately refresh and fetch the required products for the bank account link (true)\n If true, Footprint will immediately request and fetch each of the required\n products. If false, you will need to initiate",
"type": "boolean"
},
"providers": {
"description": "Advanced feature to limit which underlying providers are used\n for linking",
"type": "array",
"items": {
"type": "string"
}
},
"required_products": {
"description": "The product to require for the bank account link\n If omitted, the default is `account_numbers, transactions`",
"type": "array",
"items": {
"$ref": "#/components/schemas/BankLinkingProduct"
}
}
},
"required": [
"required_products"
]
},
"BankLinkingProduct": {
"type": "string",
"enum": [
"account_numbers",
"transactions",
"investments",
"identity"
]
},
"BankLinkingValidateResponse": {
"type": "object",
"properties": {
"id": {
"description": "the id of the bank link (if the link was created)",
"type": "string"
},
"intent_id": {
"description": "the id of the bank link intent (if only the link intent was created)",
"type": "string"
}
}
},
"BankTransactionCategory": {
"type": "string",
"enum": [
"banking",
"borrowing_and_loans",
"charity",
"dependent_costs",
"education",
"entertainment",
"expenses",
"food_and_drink",
"gambling_and_lotteries",
"general",
"health_and_personal_care",
"home",
"income",
"insurance",
"media_and_telecoms",
"mortgage_and_rent",
"pensions_savings_and_investments",
"shopping",
"taxes",
"transfers",
"transport",
"travel",
"utilities"
]
},
"BankTransactionSubcategory": {
"type": "string",
"enum": [
"account_fees_and_other_bank_charges",
"atm_fees",
"cash_withdrawals",
"currency_exchange_and_fees",
"interest",
"nsf_and_overdraft_fees",
"other_banking",
"outgoing_checks",
"overdraft_protection",
"refunds_and_reversals",
"unpaid_transactions",
"buy_now_pay_later",
"car_payment",
"cash_advance_loans",
"credit_cards",
"debt_management",
"loan_incoming",
"loan_repayment",
"other_borrowing_and_loans",
"student_loan",
"vehicle_loan",
"charity",
"other_charity",
"child_support",
"childcare",
"childrens_expenses",
"other_dependent_costs",
"driving_lessons",
"other_education",
"university_and_tuition",
"books_and_reading",
"cinema",
"gaming",
"leisure_and_amusement_activities",
"other_entertainment",
"other_events",
"sport_events",
"theatre_concerts_and_tickets",
"business_expenses",
"financial_and_legal_expenses",
"other_expenses",
"other_memberships_and_services",
"postage_and_office_supplies",
"bars_and_pubs",
"coffee",
"convenience_stores",
"eating_out_and_takeaways",
"groceries",
"other_eating_out",
"other_food_and_drink",
"speciality_food_and_drink",
"gambling_and_betting",
"lotteries_and_sweepstakes",
"other_gambling_and_lotteries",
"other_general",
"beauty",
"dental",
"gym_and_fitness",
"healthcare",
"other_health_and_personal_care",
"optical",
"pharmacies_and_health_products",
"sport_accessories_and_equipment",
"furniture",
"gardening",
"home_maintenance",
"household_goods",
"laundry",
"other_home",
"pets",
"benefits_and_social_security",
"child_support_income",
"crypto_platform_incoming",
"deposits",
"employment_income",
"investment_income",
"other_income",
"pension_income",
"rental_income",
"business_insurance",
"health_and_life_insurance",
"home_insurance",
"other_insurance",
"pet_insurance",
"travel_insurance",
"vehicle_insurance",
"broadband_phone_tv",
"digital_media_and_software",
"other_media_and_telecoms",
"tv_streaming_services",
"mortgage",
"other_mortgage_and_rent",
"rent",
"crypto_platform_outgoing",
"investments",
"pensions",
"other_pensions_savings_and_investments",
"savings",
"clothing_and_accessories",
"department_stores",
"electronics_appliances_and_technology",
"flowers_and_gifts",
"general_online_shopping",
"hobbies",
"other_shopping",
"smoking_and_vaping",
"federal_tax",
"other_taxes",
"internal_transfers",
"other_transfers",
"transfers_in",
"transfers_out",
"other_transport",
"parking_and_tolls",
"public_transport",
"taxi",
"vehicle",
"vehicle_fuel_and_charging",
"vehicle_rental",
"petrol_and_vehicle_charging",
"flights_and_airport_expenses",
"holiday_and_travel_expenses",
"other_travel",
"other_utilities",
"utilities_energy",
"utilities_water_and_sewage",
"waste_and_recycling"
]
},
"BootstrapDataV1": {
"example": {
"id.first_name": "Jane",
"id.last_name": "Doe"
},
"description": "Key-value map of bootstrap data. For more documentation on available keys, see [here](https://docs.onefootprint.com/articles/integrate/bootstrap-data#boostraping-kyb-data).",
"type": "object",
"properties": {
"business.address_line1": {
"type": "string"
},
"business.address_line2": {
"type": "string"
},
"business.city": {
"type": "string"
},
"business.corporation_type": {
"$ref": "#/components/schemas/BusinessCorporationType"
},
"business.country": {
"type": "string"
},
"business.dba": {
"type": "string"
},
"business.formation_date": {
"type": "string"
},
"business.formation_state": {
"type": "string"
},
"business.name": {
"type": "string"
},
"business.phone_number": {
"type": "string"
},
"business.primary_owner_stake": {
"type": "integer",
"format": "int64"
},
"business.secondary_owners": {
"type": "array",
"items": {
"type": "object"
}
},
"business.state": {
"type": "string"
},
"business.tin": {
"type": "string"
},
"business.website": {
"type": "string"
},
"business.zip": {
"type": "string"
},
"custom.*": {
"anyOf": [
{
"type": "string"
},
{
"type": "number",
"format": "double"
},
{
"type": "boolean"
},
{
"type": "array",
"items": {
"type": "string"
}
}
]
},
"id.address_line1": {
"type": "string"
},
"id.address_line2": {
"type": "string"
},
"id.citizenships": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Iso3166TwoDigitCountryCode"
}
},
"id.city": {
"type": "string"
},
"id.country": {
"type": "string"
},
"id.dob": {
"type": "string"
},
"id.drivers_license_number": {
"type": "string"
},
"id.drivers_license_state": {
"type": "string"
},
"id.email": {
"type": "string"
},
"id.first_name": {
"type": "string"
},
"id.itin": {
"type": "string"
},
"id.last_name": {
"type": "string"
},
"id.middle_name": {
"type": "string"
},
"id.nationality": {
"type": "string",
"enum": [
"US",
"AD",
"AE",
"AF",
"AG",
"AI",
"AL",
"AM",
"AO",
"AQ",
"AR",
"AS",
"AT",
"AU",
"AW",
"AX",
"AZ",
"BA",
"BB",
"BD",
"BE",
"BF",
"BG",
"BH",
"BI",
"BJ",
"BL",
"BM",
"BN",
"BO",
"BQ",
"BR",
"BS",
"BT",
"BV",
"BW",
"BY",
"BZ",
"CA",
"CC",
"CD",
"CF",
"CG",
"CH",
"CI",
"CK",
"CL",
"CM",
"CN",
"CO",
"CR",
"CU",
"CV",
"CW",
"CX",
"CY",
"CZ",
"DE",
"DJ",
"DK",
"DM",
"DO",
"DZ",
"EC",
"EE",
"EG",
"EH",
"ER",
"ES",
"ET",
"FI",
"FJ",
"FK",
"FM",
"FO",
"FR",
"GA",
"GB",
"GD",
"GE",
"GF",
"GG",
"GH",
"GI",
"GL",
"GM",
"GN",
"GP",
"GQ",
"GR",
"GS",
"GT",
"GU",
"GW",
"GY",
"HK",
"HM",
"HN",
"HR",
"HT",
"HU",
"ID",
"IE",
"IL",
"IM",
"IN",
"IO",
"IQ",
"IR",
"IS",
"IT",
"JE",
"JM",
"JO",
"JP",
"KE",
"KG",
"KH",
"KI",
"KM",
"KN",
"KP",
"KR",
"KW",
"KY",
"KZ",
"LA",
"LB",
"LC",
"LI",
"LK",
"LR",
"LS",
"LT",
"LU",
"LV",
"LY",
"MA",
"MC",
"MD",
"ME",
"MF",
"MG",
"MH",
"MK",
"ML",
"MM",
"MN",
"MO",
"MP",
"MQ",
"MR",
"MS",
"MT",
"MU",
"MV",
"MW",
"MX",
"MY",
"MZ",
"NA",
"NC",
"NE",
"NF",
"NG",
"NI",
"NL",
"NO",
"NP",
"NR",
"NU",
"NZ",
"OM",
"PA",
"PE",
"PF",
"PG",
"PH",
"PK",
"PL",
"PM",
"PN",
"PR",
"PS",
"PT",
"PW",
"PY",
"QA",
"RE",
"RO",
"RS",
"RU",
"RW",
"SA",
"SB",
"SC",
"SD",
"SE",
"SG",
"SH",
"SI",
"SJ",
"SK",
"SL",
"SM",
"SN",
"SO",
"SR",
"SS",
"ST",
"SV",
"SX",
"SY",
"SZ",
"TC",
"TD",
"TF",
"TG",
"TH",
"TJ",
"TK",
"TL",
"TM",
"TN",
"TO",
"TR",
"TT",
"TV",
"TW",
"TZ",
"UA",
"UG",
"UM",
"UY",
"UZ",
"VA",
"VC",
"VE",
"VG",
"VI",
"VN",
"VU",
"WF",
"WS",
"YE",
"YT",
"ZA",
"ZM",
"ZW",
"XK"
]
},
"id.phone_number": {
"type": "string"
},
"id.ssn4": {
"type": "string"
},
"id.ssn9": {
"type": "string"
},
"id.state": {
"type": "string"
},
"id.us_legal_status": {
"type": "string",
"enum": [
"citizen",
"permanent_resident",
"visa"
]
},
"id.us_tax_id": {
"type": "string"
},
"id.visa_expiration_date": {
"type": "string"
},
"id.visa_kind": {
"type": "string",
"enum": [
"b1",
"b2",
"e1",
"e2",
"e3",
"f1",
"g4",
"h1b",
"j1",
"l1",
"o1",
"tn1",
"other"
]
},
"id.zip": {
"type": "string"
}
}
},
"Business": {
"description": "Basic information about a business",
"type": "object",
"properties": {
"external_id": {
"type": "string"
},
"id": {
"example": "fp_bid_7p793EF07xKXHqAeg5VGPj",
"type": "string"
},
"requires_manual_review": {
"type": "boolean"
},
"status": {
"$ref": "#/components/schemas/ScopedVaultStatus"
},
"statuses": {
"description": "Statuses set for this business",
"type": "array",
"items": {
"$ref": "#/components/schemas/PublicEntityStatusValue"
}
}
},
"required": [
"id",
"requires_manual_review",
"status"
]
},
"BusinessCorporationType": {
"type": "string",
"enum": [
"c_corporation",
"s_corporation",
"b_corporation",
"llc",
"llp",
"partnership",
"sole_proprietorship",
"non_profit",
"unknown",
"trust",
"agent"
]
},
"BusinessDataIdentifier": {
"type": "string",
"enum": [
"business.name",
"business.dba",
"business.website",
"business.phone_number",
"business.tin",
"business.address_line1",
"business.address_line2",
"business.city",
"business.state",
"business.zip",
"business.country",
"business.beneficial_owners.*.ownership_stake",
"business.beneficial_owners.*.id.first_name",
"business.beneficial_owners.*.id.last_name",
"business.beneficial_owners.*.id.phone_number",
"business.beneficial_owners.*.id.email",
"business.beneficial_owner_explanation_message",
"business.corporation_type",
"business.formation_state",
"business.formation_date",
"custom.*"
]
},
"BusinessDecryptRequest": {
"type": "object",
"properties": {
"fields": {
"example": [
"business.name",
"business.website"
],
"description": "List of data identifiers to decrypt. For example, `business.name`, `business.website`,",
"type": "array",
"items": {
"$ref": "#/components/schemas/BusinessDataIdentifier"
}
},
"reason": {
"example": "Lorem ipsum dolor",
"description": "Reason for the data decryption. This will be logged",
"type": "string"
},
"transforms": {
"example": null,
"description": "A list of filter and transform functions to apply to each decrypted datum.\n Omit or leave empty to apply no transforms.\n Can find more information on allowed transform functions on our docs",
"type": "array",
"items": {
"$ref": "#/components/schemas/FilterFunction"
}
}
},
"required": [
"fields",
"reason"
]
},
"BusinessDecryptResponse": {
"example": {
"business.name": "Acme Bank",
"business.website": "acmebank.org"
},
"description": "A key-value map with the corresponding decrypted values",
"type": "object",
"properties": {
"": {
"type": "string",
"enum": [
"business.name",
"business.dba",
"business.website",
"business.phone_number",
"business.tin",
"business.address_line1",
"business.address_line2",
"business.city",
"business.state",
"business.zip",
"business.country",
"business.beneficial_owners.*.ownership_stake",
"business.beneficial_owners.*.id.first_name",
"business.beneficial_owners.*.id.last_name",
"business.beneficial_owners.*.id.phone_number",
"business.beneficial_owners.*.id.email",
"business.beneficial_owner_explanation_message",
"business.corporation_type",
"business.formation_state",
"business.formation_date",
"custom.*"
]
},
"": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer",
"format": "int64"
},
{
"type": "boolean"
},
{
"type": "object"
}
]
}
},
"required": [
"",
""
]
},
"BusinessDeleteRequest": {
"type": "object",
"properties": {
"delete_all": {
"example": null,
"description": "When true, deletes all data in the vault.",
"type": "boolean"
},
"fields": {
"example": [
"business.name",
"business.website"
],
"description": "List of data identifiers to delete. For example, `business.name`, `business.website`,\n `custom.account_id`",
"type": "array",
"items": {
"$ref": "#/components/schemas/BusinessDataIdentifier"
}
}
}
},
"BusinessDeleteResponse": {
"example": {
"business.name": true,
"custom.account_id": false
},
"description": "A key-value map of identifier to whether the identifier was successfully deleted in the business vault",
"type": "object",
"properties": {
"": {
"type": "string",
"enum": [
"business.name",
"business.dba",
"business.website",
"business.phone_number",
"business.tin",
"business.address_line1",
"business.address_line2",
"business.city",
"business.state",
"business.zip",
"business.country",
"business.beneficial_owners.*.ownership_stake",
"business.beneficial_owners.*.id.first_name",
"business.beneficial_owners.*.id.last_name",
"business.beneficial_owners.*.id.phone_number",
"business.beneficial_owners.*.id.email",
"business.beneficial_owner_explanation_message",
"business.corporation_type",
"business.formation_state",
"business.formation_date",
"custom.*"
]
},
"": {
"type": "boolean"
}
},
"required": [
"",
""
]
},
"BusinessInsights": {
"description": "Aggregated insights from business verification (KYB).\n\n Contains all verification results for a business entity, including name\n verification, registration records, associated people, watchlist screening,\n and address details.",
"type": "object",
"properties": {
"addresses": {
"description": "Addresses associated with the business, both submitted and discovered.",
"type": "array",
"items": {
"$ref": "#/components/schemas/InsightAddress"
}
},
"details": {
"allOf": [
{
"$ref": "#/components/schemas/InsightBusinessDetail"
},
{
"description": "General details about the business such as formation info, TIN, phone,\n and website.",
"type": "object"
}
]
},
"names": {
"description": "Business names (DBA and legal) that were submitted or discovered during\n verification, along with their verification status.",
"type": "array",
"items": {
"$ref": "#/components/schemas/InsightBusinessName"
}
},
"people": {
"description": "People associated with the business, including submitted beneficial\n owners and individuals discovered through public records.",
"type": "array",
"items": {
"$ref": "#/components/schemas/InsightPerson"
}
},
"registrations": {
"description": "Governmental registration records found for the business.",
"type": "array",
"items": {
"$ref": "#/components/schemas/InsightRegistration"
}
},
"watchlist": {
"allOf": [
{
"$ref": "#/components/schemas/InsightWatchlist"
},
{
"description": "Watchlist screening results for the business and its associated people.",
"type": "object"
}
]
}
},
"required": [
"addresses",
"names",
"people",
"registrations"
]
},
"BusinessOwner": {
"type": "object",
"properties": {
"fp_id": {
"type": "string"
},
"ownership_stake": {
"type": "integer",
"format": "int32"
}
},
"required": [
"fp_id"
]
},
"ClientDecryptRequest": {
"type": "object",
"properties": {
"fields": {
"example": [
"id.first_name",
"id.last_name"
],
"description": "List of data identifiers to decrypt. For example, `id.first_name`, `id.ssn4`,\n `custom.bank_account`",
"type": "array",
"items": {
"$ref": "#/components/schemas/UserDataIdentifier"
}
},
"reason": {
"example": "Lorem ipsum dolor",
"description": "Reason for the data decryption. This will be logged.\n The reason must be provided either here or in the client token",
"type": "string"
},
"transforms": {
"example": null,
"description": "A list of filter and transform functions to apply to each decrypted datum.\n Omit or leave empty to apply no transforms\n Can find more information on allowed transform functions on our docs",
"type": "array",
"items": {
"$ref": "#/components/schemas/FilterFunction"
}
}
}
},
"CompleteIntentRequest": {
"type": "object",
"properties": {
"external_id": {
"example": "my_link_123",
"description": "Optionally, declare an external id for the link\n which will be included in the link object and webhooks\n Note: this must be unique or else this request will fail",
"type": "string"
},
"intent_id": {
"example": "bank_link_intent_xyz123",
"description": "The bank link intent id to create a link from",
"type": "string"
}
},
"required": [
"intent_id"
]
},
"ContinueOnboardingContext": {
"type": "object",
"properties": {
"expires_at": {
"type": "string",
"format": "date-time"
},
"link": {
"example": "https://verify.onefootprint.com/?type=user#obtok_ssPvNRjNGdk8Iq9qgf6lsO2iTVhALuR4Nt",
"description": "A Footprint link embedding the `token` that can be sent to this user to allow them to\n complete the flow. This is useful to send in an automated message to the end user.",
"type": "string"
},
"token": {
"example": "obtok_UxM6Vbvk2Rcy1gzcSuXgk3sj3L9I0pAnNH",
"description": "A short-lived onboarding session token for the user to continue their onboarding flow.\n NOTE: treat this token as a secret.",
"type": "string"
}
},
"required": [
"expires_at",
"link",
"token"
]
},
"CreateClientTokenRequest": {
"type": "object",
"properties": {
"decrypt_reason": {
"description": "If the token is allowed to decrypt, provide a default decryption reason",
"type": "string"
},
"fields": {
"description": "List of data identifiers to which this token will have access. For example, `id.first_name`,\n `id.ssn4`, `custom.bank_account`. Should not be specified when using the `vault_card`\n scope.",
"type": "array",
"items": {
"$ref": "#/components/schemas/UserDataIdentifier"
}
},
"scope": {
"allOf": [
{
"$ref": "#/components/schemas/ModernClientTokenScopeKind"
},
{
"description": "Specify the permissions of this token.\n - `vault` allows writing to the specified fields.\n - `decrypt` allows decrypting the specified fields.\n - `vault_and_decrypt` allows both.\n - `decrypt_download` allows decrypting a single piece of data as a file.\n - `vault_card` is a shorthand to generate a token to vault a card with a random alias.",
"type": "string"
}
]
},
"ttl": {
"example": 300,
"description": "Time to live until this token expires, provided in seconds. Defaults to 30 minutes. Must be\n at least 60 seconds, at most 1 day",
"type": "integer",
"format": "int32"
}
},
"required": [
"scope"
]
},
"CreateClientTokenResponse": {
"type": "object",
"properties": {
"expires_at": {
"description": "The time at which the token expires",
"type": "string",
"format": "date-time"
},
"fields": {
"example": [
"id.first_name",
"id.last_name"
],
"description": "The fields that this token has permissions to operate on, according to the requested scope.",
"type": "array",
"items": {
"$ref": "#/components/schemas/UserDataIdentifier"
}
},
"token": {
"example": "cttok_UxM6Vbvk2Rcy1gzcSuXgk3sj3L9I0pAnNH",
"description": "The short-lived token that gives temporary access to perform operations for this user",
"type": "string"
}
},
"required": [
"expires_at",
"token"
]
},
"CreateOnboardingSessionRequest": {
"anyOf": [
{
"$ref": "#/components/schemas/CreateOnboardingSessionRequestOnboard"
},
{
"$ref": "#/components/schemas/CreateOnboardingSessionRequestInherit"
},
{
"$ref": "#/components/schemas/CreateOnboardingSessionRequestUpdateLoginMethods"
},
{
"$ref": "#/components/schemas/CreateOnboardingSessionRequestLinkBankAccount"
}
]
},
"CreateOnboardingSessionRequestInherit": {
"description": "If you have previously requested information from a user via the Footprint dashboard, you can\n create an onboarding session for that user that allows them to provide any remaining requested\n information",
"type": "object",
"properties": {
"fp_id": {
"description": "The identifier of the user for which the onboarding session should be created.",
"type": "string"
},
"kind": {
"x_fp_priority": 0,
"type": "string",
"enum": [
"inherit"
]
},
"ttl_min": {
"example": 60,
"description": "Time to live until this token expires, provided in minutes. Defaults to 60 minutes. Must be\n at least 1 minute, at most 3 days.",
"type": "integer",
"format": "int32"
}
},
"required": [
"fp_id",
"kind"
]
},
"CreateOnboardingSessionRequestLinkBankAccount": {
"description": "Create an onboarding session that prompts the user to link a bank account.\n Note: this is requires access to Footprint's bank linking.",
"type": "object",
"properties": {
"config": {
"allOf": [
{
"$ref": "#/components/schemas/BankLinkingConfig"
},
{
"example": null,
"description": "Optionally configure the bank linking widget for the onboarding session",
"type": "object"
}
]
},
"fp_id": {
"example": "fp_id_xyz...124",
"description": "The identifier of the user for which the onboarding session should be created. Cannot be\n provided alongside `user_external_id`.",
"type": "string"
},
"key": {
"description": "The playbook key that should be used for the onboarding.\n Must be a playbook configured for bank linking.",
"type": "string"
},
"kind": {
"x_fp_priority": 0,
"type": "string",
"enum": [
"link_bank_account"
]
},
"user_external_id": {
"example": null,
"description": "Optionally this user's identifier in your own database.\n If a user with this external ID already exists within the Footprint ecosystem, we will\n select it. If not, the user created by this onboarding session will have this as its\n `external_id`.\n Cannot be provided alongside `fp_id`.",
"x_fp_collapsed": true,
"type": "string"
}
},
"required": [
"config",
"key",
"kind"
]
},
"CreateOnboardingSessionRequestOnboard": {
"description": "Create an onboarding session that prompts the user to onboarding onto the specified playbook.",
"allOf": [
{
"description": "Create an onboarding session that prompts the user to onboarding onto the specified playbook.",
"type": "object",
"properties": {
"bootstrap_data": {
"allOf": [
{
"$ref": "#/components/schemas/BootstrapDataV1"
},
{
"example": {
"id.first_name": "Jane",
"id.last_name": "Doe"
},
"description": "Optionally, any user or business bootstrap data that you would like to pass into the\n onboarding flow.\n For information on what fields are available to bootstrap and their data formats, see [here](https://docs.onefootprint.com/articles/integrate/bootstrap-data).",
"type": "object"
}
]
},
"business_external_id": {
"example": null,
"description": "When using a KYB playbook, optionally this business's identifier in your own database.\n If a business with this external ID owned by the identified user already exists within\n the Footprint ecosystem, we will select it. If not, we will create a new\n business with this as its `external_id`.\n Cannot be provided alongside `fp_bid`.\n NOTE: the identified user must already own the business with this external ID or they\n will receive an error during onboarding.",
"x_fp_collapsed": true,
"type": "string"
},
"consent": {
"example": null,
"description": "Optionally, context on any consent forms displayed to the user before launching the\n Footprint flow.",
"x_fp_preview_gate": "third_party_auth",
"x_fp_collapsed": true,
"type": "array",
"items": {
"$ref": "#/components/schemas/UserConsentContext"
}
},
"fp_id": {
"example": null,
"description": "The identifier of the user for which the onboarding session should be created. Cannot be\n provided alongside `user_external_id`.",
"x_fp_collapsed": true,
"type": "string"
},
"onboarding_data": {
"allOf": [
{
"$ref": "#/components/schemas/InputOnboardingData"
},
{
"example": null,
"description": "Optionally, any initial onboarding data to start with. This data will be available in\n template contexts and branch nodes under the `data.` prefix.",
"x_fp_collapsed": true,
"type": "object"
}
]
},
"onboarding_external_id": {
"example": null,
"description": "By default, if no `onboarding_external_id` is provided, a user will only be allowed to\n onboard onto a playbook one time. Use `onboarding_external_id` to control onboarding\n idempotency and associate an onboarding with an event in your application.\n
\n For more information, see [here](https://docs.onefootprint.com/articles/integrate/onboarding-sessions#example-use-cases-onboarding-idempotency).\n
\n When a user onboards using this token, Footprint will look up previous onboardings\n onto this playbook. If there is a matching onboarding with the provided\n `onboarding_external_id` (or if no `onboarding_external_id` is provided), the matching\n onboarding's results will be reused and returned without allowing the user to edit their\n data, run any verification checks, or re-evalute rules. The flow will close once the user\n logs in.\n
\n If there is no matching onboarding, a new onboarding will be created and the user will be\n allowed to onboard as normal.\n
\n Can only be provided if `fp_id` or `user_external_id` is provided.",
"x_fp_collapsed": true,
"type": "string"
},
"sandbox_id": {
"example": null,
"description": "If using a sandbox playbook, optionally the sandbox ID to use for the onboarding\n session. A sandbox ID will be generated if not provided for a sandbox playbook.",
"type": "string"
},
"sandbox_outcome": {
"allOf": [
{
"$ref": "#/components/schemas/OnboardingSessionFixtureResult"
},
{
"example": null,
"description": "If using a sandbox playbook, optionally the outcome of the onboarding session.",
"x_fp_collapsed": true,
"type": "string"
}
]
},
"third_party_auth": {
"allOf": [
{
"$ref": "#/components/schemas/ThirdPartyAuthInfo"
},
{
"example": null,
"description": "Optionally, information about OTP performed by your organization before launching the\n Footprint flow.",
"x_fp_preview_gate": "third_party_auth",
"x_fp_collapsed": true,
"type": "object"
}
]
},
"ttl_min": {
"example": 720,
"description": "Time to live until this token expires, provided in minutes. Defaults to 12 hours. Must be\n at least 1 minute, at most 3 days.",
"type": "integer",
"format": "int32"
},
"use_implicit_auth": {
"example": null,
"description": "When true, will not require physical authentication from the user if they have logged\n into your organization recently.\n This may be useful if a user is running through multiple playbooks and has already\n recently logged in.",
"x_fp_preview_gate": "implicit_auth",
"x_fp_collapsed": true,
"type": "boolean"
},
"user_external_id": {
"example": null,
"description": "Optionally this user's identifier in your own database.\n If a user with this external ID already exists within the Footprint ecosystem, we will\n select it. If not, the user created by this onboarding session will have this as its\n `external_id`.\n Cannot be provided alongside `fp_id`.",
"x_fp_collapsed": true,
"type": "string"
}
},
"required": [
"use_implicit_auth"
]
},
{
"$ref": "#/components/schemas/OnboardingRequestPbKey"
},
{
"type": "object",
"properties": {
"kind": {
"x_fp_priority": 0,
"type": "string",
"enum": [
"onboard"
]
}
},
"required": [
"kind"
]
}
]
},
"CreateOnboardingSessionRequestUpdateLoginMethods": {
"description": "Generate a token and link that allows the user to update their contact info",
"type": "object",
"properties": {
"fp_id": {
"example": null,
"description": "The identifier of the user for which the onboarding session should be created.",
"type": "string"
},
"kind": {
"x_fp_priority": 0,
"type": "string",
"enum": [
"update_login_methods"
]
},
"limit_auth_methods": {
"example": null,
"description": "Can only be provided when the kind is `update_login_methods`. The set of auth methods\n that you would like to be allowed to be updated. When not provided, the token\n allows updating any auth method.",
"type": "array",
"items": {
"$ref": "#/components/schemas/AuthMethodKind"
}
}
},
"required": [
"fp_id",
"kind"
]
},
"CreateOnboardingSessionResponse": {
"type": "object",
"properties": {
"expires_at": {
"type": "string",
"format": "date-time"
},
"link": {
"example": "https://verify.onefootprint.com/?type=user#obtok_ssPvNRjNGdk8Iq9qgf6lsO2iTVhALuR4Nt",
"description": "A Footprint link embedding the `token` that can be sent to this user to allow them to\n complete the flow. This is useful to send in an automated message to the end user.",
"type": "string"
},
"token": {
"example": "obtok_UxM6Vbvk2Rcy1gzcSuXgk3sj3L9I0pAnNH",
"description": "A short-lived onboarding session token that can be passed into the frontend SDK as a\n `authToken`. This token contains all information on the provided public key and/or bootstrap\n data provided.\n NOTE: treat this token as a secret as it allows viewing the provided bootstrap data.",
"type": "string"
}
},
"required": [
"expires_at",
"link",
"token"
]
},
"CreateTagRequest": {
"type": "object",
"properties": {
"tag": {
"example": "transaction_chargeback",
"description": "Any string to tag the user",
"type": "string"
}
},
"required": [
"tag"
]
},
"CreateTokenResponse": {
"type": "object",
"properties": {
"expires_at": {
"description": "The time at which the token (and link) expire",
"type": "string",
"format": "date-time"
},
"link": {
"example": "https://verify.onefootprint.com/?type=user#utok_ssPvNRjNGdk8Iq9qgf6lsO2iTVhALuR4Nt",
"description": "A Footprint link embedding the `token` that can be sent to this user to allow them to\n complete the flow. This is useful to send in an automated message to the end user.",
"type": "string"
},
"token": {
"example": "utok_ssPvNRjNGdk8Iq9qgf6lsO2iTVhALuR4Nt",
"description": "A short-lived token that can be passed into the Verify SDK to allow the user to complete the\n flow. This is useful when you'd like to open a native interface inside your app for the user\n to complete the flow.",
"type": "string"
}
},
"required": [
"expires_at",
"link",
"token"
]
},
"CreateUserDecisionRequest": {
"type": "object",
"properties": {
"annotation": {
"description": "Human-readable explanation for the manual review that will be displayed in the user timeline\n on the dashboard.",
"type": "string"
},
"status": {
"$ref": "#/components/schemas/TerminalDecisionStatus"
}
},
"required": [
"annotation",
"status"
]
},
"CursorPaginatedLinkInfo": {
"description": "",
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/LinkInfo"
}
},
"meta": {
"type": "object",
"properties": {
"count": {
"example": 10000,
"description": "The total number of results.",
"type": "integer",
"format": "int64"
},
"next": {
"description": "The `cursor` parameter to provide in order to request the next page of results.",
"type": "string"
}
}
}
},
"required": [
"data",
"meta"
]
},
"CursorPaginatedLiteUser": {
"description": "",
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/LiteUser"
}
},
"meta": {
"type": "object",
"properties": {
"count": {
"example": 10000,
"description": "The total number of results.",
"type": "integer",
"format": "int64"
},
"next": {
"description": "The `cursor` parameter to provide in order to request the next page of results.",
"type": "integer"
}
}
}
},
"required": [
"data",
"meta"
]
},
"DataIdentifier": {
"type": "string",
"enum": [
"id.first_name",
"id.middle_name",
"id.last_name",
"id.dob",
"id.ssn4",
"id.ssn9",
"id.address_line1",
"id.address_line2",
"id.city",
"id.state",
"id.zip",
"id.country",
"id.email",
"id.phone_number",
"id.us_legal_status",
"id.visa_kind",
"id.visa_expiration_date",
"id.nationality",
"id.citizenships",
"id.drivers_license_number",
"id.drivers_license_state",
"id.itin",
"id.us_tax_id",
"business.name",
"business.dba",
"business.website",
"business.phone_number",
"business.tin",
"business.address_line1",
"business.address_line2",
"business.city",
"business.state",
"business.zip",
"business.country",
"business.beneficial_owners.*.ownership_stake",
"business.beneficial_owners.*.id.first_name",
"business.beneficial_owners.*.id.last_name",
"business.beneficial_owners.*.id.phone_number",
"business.beneficial_owners.*.id.email",
"business.beneficial_owner_explanation_message",
"business.corporation_type",
"business.formation_state",
"business.formation_date",
"custom.*",
"investor_profile.employment_status",
"investor_profile.occupation",
"investor_profile.employer",
"investor_profile.annual_income",
"investor_profile.net_worth",
"investor_profile.investment_goals",
"investor_profile.risk_tolerance",
"investor_profile.declarations",
"investor_profile.brokerage_firm_employer",
"investor_profile.senior_executive_symbols",
"investor_profile.family_member_names",
"investor_profile.political_organization",
"investor_profile.funding_sources",
"document.id_card.front.image",
"document.id_card.front.latest_upload",
"document.id_card.front.mime_type",
"document.id_card.back.image",
"document.id_card.back.latest_upload",
"document.id_card.back.mime_type",
"document.id_card.selfie.image",
"document.id_card.selfie.latest_upload",
"document.id_card.selfie.mime_type",
"document.id_card.full_name",
"document.id_card.first_name",
"document.id_card.last_name",
"document.id_card.dob",
"document.id_card.gender",
"document.id_card.full_address",
"document.id_card.address_line1",
"document.id_card.city",
"document.id_card.state",
"document.id_card.country",
"document.id_card.postal_code",
"document.id_card.document_number",
"document.id_card.expires_at",
"document.id_card.issued_at",
"document.id_card.issuing_state",
"document.id_card.issuing_country",
"document.id_card.ref_number",
"document.id_card.nationality",
"document.id_card.curp",
"document.id_card.clave_de_elector",
"document.id_card.classified_document_type",
"document.id_card.curp_validation_response",
"document.id_card.samba_activity_history_response",
"document.id_card.us_issuing_state",
"document.drivers_license.front.image",
"document.drivers_license.front.latest_upload",
"document.drivers_license.front.mime_type",
"document.drivers_license.back.image",
"document.drivers_license.back.latest_upload",
"document.drivers_license.back.mime_type",
"document.drivers_license.selfie.image",
"document.drivers_license.selfie.latest_upload",
"document.drivers_license.selfie.mime_type",
"document.drivers_license.full_name",
"document.drivers_license.first_name",
"document.drivers_license.last_name",
"document.drivers_license.dob",
"document.drivers_license.gender",
"document.drivers_license.full_address",
"document.drivers_license.address_line1",
"document.drivers_license.city",
"document.drivers_license.state",
"document.drivers_license.country",
"document.drivers_license.postal_code",
"document.drivers_license.document_number",
"document.drivers_license.expires_at",
"document.drivers_license.issued_at",
"document.drivers_license.issuing_state",
"document.drivers_license.issuing_country",
"document.drivers_license.ref_number",
"document.drivers_license.nationality",
"document.drivers_license.curp",
"document.drivers_license.clave_de_elector",
"document.drivers_license.classified_document_type",
"document.drivers_license.curp_validation_response",
"document.drivers_license.samba_activity_history_response",
"document.drivers_license.us_issuing_state",
"document.passport.front.image",
"document.passport.front.latest_upload",
"document.passport.front.mime_type",
"document.passport.back.image",
"document.passport.back.latest_upload",
"document.passport.back.mime_type",
"document.passport.selfie.image",
"document.passport.selfie.latest_upload",
"document.passport.selfie.mime_type",
"document.passport.full_name",
"document.passport.first_name",
"document.passport.last_name",
"document.passport.dob",
"document.passport.gender",
"document.passport.full_address",
"document.passport.address_line1",
"document.passport.city",
"document.passport.state",
"document.passport.country",
"document.passport.postal_code",
"document.passport.document_number",
"document.passport.expires_at",
"document.passport.issued_at",
"document.passport.issuing_state",
"document.passport.issuing_country",
"document.passport.ref_number",
"document.passport.nationality",
"document.passport.curp",
"document.passport.clave_de_elector",
"document.passport.classified_document_type",
"document.passport.curp_validation_response",
"document.passport.samba_activity_history_response",
"document.passport.us_issuing_state",
"document.passport_card.front.image",
"document.passport_card.front.latest_upload",
"document.passport_card.front.mime_type",
"document.passport_card.back.image",
"document.passport_card.back.latest_upload",
"document.passport_card.back.mime_type",
"document.passport_card.selfie.image",
"document.passport_card.selfie.latest_upload",
"document.passport_card.selfie.mime_type",
"document.passport_card.full_name",
"document.passport_card.first_name",
"document.passport_card.last_name",
"document.passport_card.dob",
"document.passport_card.gender",
"document.passport_card.full_address",
"document.passport_card.address_line1",
"document.passport_card.city",
"document.passport_card.state",
"document.passport_card.country",
"document.passport_card.postal_code",
"document.passport_card.document_number",
"document.passport_card.expires_at",
"document.passport_card.issued_at",
"document.passport_card.issuing_state",
"document.passport_card.issuing_country",
"document.passport_card.ref_number",
"document.passport_card.nationality",
"document.passport_card.curp",
"document.passport_card.clave_de_elector",
"document.passport_card.classified_document_type",
"document.passport_card.curp_validation_response",
"document.passport_card.samba_activity_history_response",
"document.passport_card.us_issuing_state",
"document.permit.front.image",
"document.permit.front.latest_upload",
"document.permit.front.mime_type",
"document.permit.back.image",
"document.permit.back.latest_upload",
"document.permit.back.mime_type",
"document.permit.selfie.image",
"document.permit.selfie.latest_upload",
"document.permit.selfie.mime_type",
"document.permit.full_name",
"document.permit.first_name",
"document.permit.last_name",
"document.permit.dob",
"document.permit.gender",
"document.permit.full_address",
"document.permit.address_line1",
"document.permit.city",
"document.permit.state",
"document.permit.country",
"document.permit.postal_code",
"document.permit.document_number",
"document.permit.expires_at",
"document.permit.issued_at",
"document.permit.issuing_state",
"document.permit.issuing_country",
"document.permit.ref_number",
"document.permit.nationality",
"document.permit.curp",
"document.permit.clave_de_elector",
"document.permit.classified_document_type",
"document.permit.curp_validation_response",
"document.permit.samba_activity_history_response",
"document.permit.us_issuing_state",
"document.visa.front.image",
"document.visa.front.latest_upload",
"document.visa.front.mime_type",
"document.visa.back.image",
"document.visa.back.latest_upload",
"document.visa.back.mime_type",
"document.visa.selfie.image",
"document.visa.selfie.latest_upload",
"document.visa.selfie.mime_type",
"document.visa.full_name",
"document.visa.first_name",
"document.visa.last_name",
"document.visa.dob",
"document.visa.gender",
"document.visa.full_address",
"document.visa.address_line1",
"document.visa.city",
"document.visa.state",
"document.visa.country",
"document.visa.postal_code",
"document.visa.document_number",
"document.visa.expires_at",
"document.visa.issued_at",
"document.visa.issuing_state",
"document.visa.issuing_country",
"document.visa.ref_number",
"document.visa.nationality",
"document.visa.curp",
"document.visa.clave_de_elector",
"document.visa.classified_document_type",
"document.visa.curp_validation_response",
"document.visa.samba_activity_history_response",
"document.visa.us_issuing_state",
"document.residence_document.front.image",
"document.residence_document.front.latest_upload",
"document.residence_document.front.mime_type",
"document.residence_document.back.image",
"document.residence_document.back.latest_upload",
"document.residence_document.back.mime_type",
"document.residence_document.selfie.image",
"document.residence_document.selfie.latest_upload",
"document.residence_document.selfie.mime_type",
"document.residence_document.full_name",
"document.residence_document.first_name",
"document.residence_document.last_name",
"document.residence_document.dob",
"document.residence_document.gender",
"document.residence_document.full_address",
"document.residence_document.address_line1",
"document.residence_document.city",
"document.residence_document.state",
"document.residence_document.country",
"document.residence_document.postal_code",
"document.residence_document.document_number",
"document.residence_document.expires_at",
"document.residence_document.issued_at",
"document.residence_document.issuing_state",
"document.residence_document.issuing_country",
"document.residence_document.ref_number",
"document.residence_document.nationality",
"document.residence_document.curp",
"document.residence_document.clave_de_elector",
"document.residence_document.classified_document_type",
"document.residence_document.curp_validation_response",
"document.residence_document.samba_activity_history_response",
"document.residence_document.us_issuing_state",
"document.voter_identification.front.image",
"document.voter_identification.front.latest_upload",
"document.voter_identification.front.mime_type",
"document.voter_identification.back.image",
"document.voter_identification.back.latest_upload",
"document.voter_identification.back.mime_type",
"document.voter_identification.selfie.image",
"document.voter_identification.selfie.latest_upload",
"document.voter_identification.selfie.mime_type",
"document.voter_identification.full_name",
"document.voter_identification.first_name",
"document.voter_identification.last_name",
"document.voter_identification.dob",
"document.voter_identification.gender",
"document.voter_identification.full_address",
"document.voter_identification.address_line1",
"document.voter_identification.city",
"document.voter_identification.state",
"document.voter_identification.country",
"document.voter_identification.postal_code",
"document.voter_identification.document_number",
"document.voter_identification.expires_at",
"document.voter_identification.issued_at",
"document.voter_identification.issuing_state",
"document.voter_identification.issuing_country",
"document.voter_identification.ref_number",
"document.voter_identification.nationality",
"document.voter_identification.curp",
"document.voter_identification.clave_de_elector",
"document.voter_identification.classified_document_type",
"document.voter_identification.curp_validation_response",
"document.voter_identification.samba_activity_history_response",
"document.voter_identification.us_issuing_state",
"document.finra_compliance_letter",
"document.proof_of_address.image",
"document.ssn_card.image",
"document.custom.*",
"card.*.number",
"card.*.expiration",
"card.*.cvc",
"card.*.name",
"card.*.billing_address.zip",
"card.*.billing_address.country",
"card.*.expiration_month",
"card.*.expiration_year",
"card.*.number_last4",
"card.*.issuer",
"card.*.fingerprint",
"bank.*.name",
"bank.*.ach_routing_number",
"bank.*.ach_wire_routing_number",
"bank.*.ach_account_number",
"bank.*.ach_account_id",
"bank.*.account_type",
"bank.*.institution_id",
"bank.*.institution_name",
"bank.*.account_last4",
"bank.*.iban",
"bank.*.bic",
"bank.*.owners",
"bank.*.mk_link_id",
"bank.*.link_id",
"bank.*.closed",
"bank.*.fingerprint"
]
},
"DecisionStatus": {
"type": "string",
"enum": [
"fail",
"pass",
"none"
]
},
"DeleteRequest": {
"type": "object",
"properties": {
"delete_all": {
"example": null,
"description": "When true, deletes all data in the vault.",
"type": "boolean"
},
"fields": {
"example": [
"id.first_name",
"id.last_name"
],
"description": "List of data identifiers to delete. For example, `id.first_name`, `id.ssn4`,\n `custom.account_id`",
"type": "array",
"items": {
"$ref": "#/components/schemas/UserDataIdentifier"
}
}
}
},
"DeviceInsightsResponse": {
"type": "object",
"properties": {
"fingerprints": {
"description": "An array of device fingerprints captured during the onboarding",
"type": "array",
"items": {
"$ref": "#/components/schemas/FingerprintEvent"
}
},
"ip_address": {
"description": "The IP address when the onboarding started",
"type": "string"
}
},
"required": [
"fingerprints"
]
},
"DisclosureContext": {
"description": "If you utilize Alpaca for KYCaaS, additional information will need to be submitted if the user\n identifies with any of the disclosures before the account can be approved. This information can\n be sent through the context object to speed up the time to approve their account.",
"type": "object",
"properties": {
"company_city": {
"description": "Required if context_type = AFFILIATE_FIRM or CONTROLLED_FIRM",
"type": "string"
},
"company_compliance_email": {
"description": "Required if context_type = AFFILIATE_FIRM or CONTROLLED_FIRM",
"type": "string"
},
"company_country": {
"description": "Required if context_type = AFFILIATE_FIRM or CONTROLLED_FIRM",
"type": "string"
},
"company_name": {
"description": "Required if context_type = AFFILIATE_FIRM or CONTROLLED_FIRM",
"type": "string"
},
"company_state": {
"description": "Required if company_country = USA",
"type": "string"
},
"company_street_address": {
"description": "Required if context_type = AFFILIATE_FIRM or CONTROLLED_FIRM",
"type": "array",
"items": {
"type": "string"
}
},
"context_type": {
"$ref": "#/components/schemas/AlpacaContextType"
},
"family_name": {
"description": "Required if context_type = IMMEDIATE_FAMILY_EXPOSED",
"type": "string"
},
"given_name": {
"description": "Required if context_type = IMMEDIATE_FAMILY_EXPOSED",
"type": "string"
}
},
"required": [
"company_city",
"company_compliance_email",
"company_country",
"company_name",
"company_state",
"company_street_address",
"context_type",
"family_name",
"given_name"
]
},
"Disclosures": {
"description": "It is your responsibility as the service provider to denote if the account owner falls under\n each category defined by FINRA rules. We recommend asking these questions at any point of the\n onboarding process of each account owner in the form of Y/N and Radio Buttons.",
"type": "object",
"properties": {
"context": {
"description": "Information relevant to the user\u2019s disclosure selection should be sent through this object.",
"type": "array",
"items": {
"$ref": "#/components/schemas/DisclosureContext"
}
},
"employer_address": {
"type": "string"
},
"employer_name": {
"type": "string"
},
"employment_position": {
"type": "string"
},
"employment_sector": {
"type": "string"
},
"employment_status": {
"$ref": "#/components/schemas/AlpacaEmploymentStatus"
},
"immediate_family_exposed": {
"description": "If your user\u2019s immediate family member (sibling, husband/wife, child, parent) is either\n politically exposed or holds a control position.",
"type": "boolean"
},
"is_affiliated_exchange_or_finra": {
"type": "boolean"
},
"is_control_person": {
"description": "Whether user holds a controlling position in a publicly traded company, member of the board\n of directors or has policy making abilities in a publicly traded company.",
"type": "boolean"
},
"is_politically_exposed": {
"type": "boolean"
}
},
"required": [
"immediate_family_exposed",
"is_affiliated_exchange_or_finra",
"is_control_person",
"is_politically_exposed"
]
},
"DocumentDataForRequest": {
"type": "object",
"properties": {
"back": {
"allOf": [
{
"$ref": "#/components/schemas/DataIdentifier"
},
{
"description": "The vault identifier for the back side of the document. Expected format:\n `document.[doc_kind].back.image`",
"type": "string"
}
]
},
"front": {
"allOf": [
{
"$ref": "#/components/schemas/DataIdentifier"
},
{
"description": "The vault identifier for the front side of the document. Expected format:\n `document.[doc_kind].front.image`",
"type": "string"
}
]
},
"selfie": {
"allOf": [
{
"$ref": "#/components/schemas/DataIdentifier"
},
{
"description": "The vault identifier for the selfie. Expected format: `document.[doc_kind].selfie.image`",
"type": "string"
}
]
}
},
"required": [
"front"
]
},
"DocumentFixtureResult": {
"type": "string",
"enum": [
"fail",
"pass",
"real"
]
},
"DocumentImage": {
"type": "object",
"properties": {
"identifier": {
"allOf": [
{
"$ref": "#/components/schemas/DataIdentifier"
},
{
"description": "The vault identifier used to fetch the document from the vault",
"type": "string"
}
]
},
"version": {
"description": "The version of the document",
"type": "integer",
"format": "int64"
}
},
"required": [
"identifier",
"version"
]
},
"DocumentImages": {
"type": "object",
"properties": {
"back": {
"allOf": [
{
"$ref": "#/components/schemas/DocumentImage"
},
{
"description": "Information about the back of the document",
"type": "object"
}
]
},
"front": {
"allOf": [
{
"$ref": "#/components/schemas/DocumentImage"
},
{
"description": "Information about the front of the document",
"type": "object"
}
]
},
"selfie": {
"allOf": [
{
"$ref": "#/components/schemas/DocumentImage"
},
{
"description": "Information about the selfie, if collected",
"type": "object"
}
]
}
}
},
"DocumentKind": {
"type": "string",
"enum": [
"id_card",
"drivers_license",
"passport",
"passport_card",
"permit",
"visa",
"residence_document",
"voter_identification",
"ssn_card",
"proof_of_address",
"custom"
]
},
"DupeKind": {
"type": "string",
"enum": [
"ssn9",
"email",
"phone_number",
"name_dob",
"device_id",
"cookie_id",
"selfie",
"name_ssn4",
"dob_ssn4",
"bank_routing_account",
"card_number_cvc",
"identity_document_number"
]
},
"Empty": {
"description": "Empty JSON.",
"type": "object"
},
"EntityStatusChangedPayload": {
"example": {
"event_kind": "footprint.entity.entity_status_set",
"entity_kind": "person",
"fp_id": "fp_id_xyz",
"status": {
"kind": "verification_status",
"value": "verified"
},
"is_live": false,
"timestamp": "2024-06-14T02:40:00Z"
},
"title": "footprint.entity.entity_status_set",
"description": "A custom status was set, updated, or cleared on an Footprint user or business entity.",
"type": "object",
"properties": {
"entity_kind": {
"$ref": "#/components/schemas/VaultKind"
},
"event_kind": {
"type": "string",
"enum": [
"footprint.entity.entity_status_set"
]
},
"fp_id": {
"type": "string"
},
"is_live": {
"type": "boolean"
},
"status": {
"$ref": "#/components/schemas/EntityStatusPayload"
},
"timestamp": {
"type": "string",
"format": "date-time"
}
},
"required": [
"entity_kind",
"event_kind",
"fp_id",
"is_live",
"status",
"timestamp"
]
},
"EntityStatusPayload": {
"type": "object",
"properties": {
"kind": {
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"kind"
]
},
"EntityValidateResponse": {
"type": "object",
"properties": {
"external_id": {
"example": null,
"description": "The `external_id` provided for this user or business, if any.",
"type": "string"
},
"fp_id": {
"type": "string"
},
"onboarding_external_id": {
"example": null,
"description": "The `external_id` provided for this onboarding, if any.",
"type": "string"
},
"onboarding_id": {
"example": "ob_SRFT2a1mN7DAWJ0VPXkiqK",
"type": "string"
},
"playbook_key": {
"example": "pb_live_fZvYlX3JpanlQ3MAwE45g0",
"type": "string"
},
"requires_manual_review": {
"type": "boolean"
},
"status": {
"allOf": [
{
"$ref": "#/components/schemas/OnboardingStatus"
},
{
"description": "The decision for this onboarding issued by the Action nodes on your playbook. For more\n information on interpreting statuses, see\n [here](https://docs.onefootprint.com/articles/guide/definitive-integration-guide#the-end-to-end-integration-step-5-process-the-validation-token-the-verification-result).",
"type": "string"
}
]
}
},
"required": [
"fp_id",
"onboarding_id",
"playbook_key",
"requires_manual_review",
"status"
]
},
"FieldValidation": {
"description": "A risk event",
"type": "object",
"properties": {
"match_level": {
"$ref": "#/components/schemas/MatchLevel"
},
"signals": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FieldValidationDetail"
}
}
},
"required": [
"match_level",
"signals"
]
},
"FieldValidationDetail": {
"type": "object",
"properties": {
"description": {
"type": "string"
},
"match_level": {
"$ref": "#/components/schemas/MatchLevel"
},
"note": {
"type": "string"
},
"reason_code": {
"$ref": "#/components/schemas/FootprintReasonCode"
},
"severity": {
"$ref": "#/components/schemas/SignalSeverity"
}
},
"required": [
"description",
"match_level",
"note",
"reason_code",
"severity"
]
},
"FilterFunction": {
"description": "Represents a data transform to apply to underlying plaintext behind a data identifier. Specify only one of the following fields. See more here: https://docs.onefootprint.com/articles/vault/proxy#filter-functions",
"type": "string",
"enum": [
"to_lowercase",
"to_uppercase",
"to_ascii",
"prefix()",
"suffix()",
"replace('','')",
"date_format('','')",
"hmac_sha256('')",
"encrypt('','')",
"wrap_quotes"
]
},
"FingerprintEvent": {
"type": "object",
"properties": {
"confidence_score": {
"description": "a confidence score between 0 and 1 indicating the likelihood of the captured attributes",
"type": "number",
"format": "double"
},
"device_id": {
"description": "a unique device identifier",
"type": "string"
},
"is_bot": {
"type": "boolean"
},
"is_data_center": {
"type": "boolean"
},
"is_high_activity": {
"type": "boolean"
},
"is_incognito": {
"type": "boolean"
},
"is_privacy_settings": {
"type": "boolean"
},
"is_public_proxy": {
"type": "boolean"
},
"is_tampering": {
"type": "boolean"
},
"is_tor_exit_node": {
"type": "boolean"
},
"is_virtual_machine": {
"type": "boolean"
},
"is_vpn": {
"type": "boolean"
},
"suspect_score": {
"description": "a score between 0 and 100 indicating whether the device is suspicious",
"type": "integer",
"format": "int32"
}
},
"required": [
"device_id"
]
},
"FootprintReasonCode": {
"type": "string",
"enum": [
"watchlist_hit_ofac",
"watchlist_clear_ofac",
"watchlist_hit_non_sdn",
"watchlist_clear_non_sdn",
"watchlist_hit_warning",
"watchlist_clear_warning",
"watchlist_hit_pep",
"watchlist_clear_pep",
"adverse_media_hit",
"adverse_media_clear",
"id_not_located",
"id_flagged",
"credit_more_than3_inquiries_in_last30_days",
"credit_established_before_ssn_date",
"address_input_is_non_residential",
"address_located_is_non_residential",
"address_does_not_match",
"address_partially_matches",
"address_zip_code_does_not_match",
"address_city_does_not_match",
"address_city_matches",
"address_street_name_does_not_match",
"address_street_name_partially_matches",
"address_street_number_does_not_match",
"address_state_does_not_match",
"address_input_is_not_deliverable",
"address_input_is_po_box",
"address_input_is_correctional_facility",
"address_input_is_not_standard_campground",
"address_input_is_not_standard_college",
"address_input_is_not_standard_general_delivery",
"address_input_is_not_standard_hospital",
"address_input_is_not_standard_hotel",
"address_input_is_not_standard_mail_drop",
"address_input_is_not_standard_prison",
"address_input_is_not_standard_university",
"address_input_is_not_standard_uspo",
"address_input_not_on_file",
"address_located_is_po_box",
"address_located_is_not_standard_campground",
"address_located_is_not_standard_college",
"address_located_is_not_standard_general_delivery",
"address_located_is_not_standard_hospital",
"address_located_is_not_standard_hotel",
"address_located_is_not_standard_mail_drop",
"address_located_is_not_standard_prison",
"address_located_is_not_standard_university",
"address_located_is_not_standard_uspo",
"address_located_is_high_risk_address",
"address_risk_alert",
"address_alert_velocity",
"address_alert_stability",
"address_alert_longevity",
"address_alert_single_address_in_file",
"address_newer_record_found",
"dob_yob_does_not_match",
"dob_yob_does_not_match_within1_year",
"dob_mob_does_not_match",
"dob_day_does_not_match",
"dob_mob_not_available",
"dob_yob_not_available",
"dob_located_age_below_minimum",
"dob_located_age_above_maximum",
"dob_located_coppa_alert",
"dob_does_not_match",
"dob_partial_match",
"dob_not_on_file",
"dob_could_not_match",
"dob_input_age_less_than18",
"ssn_not_available",
"ssn_not_on_file",
"ssn_partially_matches",
"ssn_does_not_match",
"ssn_does_not_match_within1_digit",
"ssn_input_is_itin",
"ssn_located_is_itin",
"ssn_input_tied_to_multiple_names",
"ssn_input_is_invalid",
"ssn_located_is_invalid",
"ssn_not_provided",
"us_tax_id_is_itin",
"itin_is_expired",
"name_last_does_not_match",
"name_last_partially_matches",
"name_matches",
"name_does_not_match",
"name_partially_matches",
"ip_proxy",
"ip_data_center",
"email_address_invalid",
"email_address_or_domain_does_not_exist",
"email_domain_recently_created",
"email_domain_private",
"email_domain_corporate",
"email_recently_verified",
"email_found_on_file",
"email_not_found_on_file",
"email_high_risk_country",
"email_high_risk_fraud",
"email_high_risk_tumbled",
"email_high_risk_disposable",
"email_high_risk_domain",
"sentilink_synthetic_identity_high_risk",
"sentilink_synthetic_identity_medium_risk",
"sentilink_synthetic_identity_low_risk",
"sentilink_identity_theft_high_risk",
"sentilink_identity_theft_medium_risk",
"sentilink_identity_theft_low_risk",
"sentilink_invalid_dob",
"phone_number_input_invalid",
"phone_number_located_is_voip",
"phone_number_is_voip",
"phone_located_matches",
"phone_located_partially_matches",
"phone_located_does_not_match",
"phone_located_name_matches",
"phone_located_name_partially_matches",
"phone_located_name_does_not_match",
"phone_located_address_matches",
"phone_located_address_partially_matches",
"phone_located_address_does_not_match",
"phone_input_likely_belongs_to_another",
"phone_not_provided",
"multiple_records_found",
"subject_deceased",
"bureau_deleted_record",
"ssn_issued_prior_to_dob",
"ssn_issue_date_cannot_be_verified",
"ssn_located_issue_date_cannot_be_verified",
"ssn_potentially_belongs_to_another",
"ssn_likely_belongs_to_another",
"thin_file",
"input_phone_number_does_not_match_input_state",
"input_phone_number_does_not_match_located_state_history",
"drivers_license_number_different_number_found",
"drivers_license_number_not_on_record",
"drivers_license_number_not_valid",
"drivers_license_number_is_valid",
"document_upload_failed",
"document_not_verified",
"document_verified",
"document_ocr_not_successful",
"document_ocr_successful",
"document_barcode_could_not_be_read",
"document_barcode_could_be_read",
"document_barcode_content_matches",
"document_barcode_content_does_not_match",
"document_barcode_detected",
"document_barcode_could_not_be_detected",
"document_expired",
"document_not_expired",
"document_type_not_allowed",
"document_field_crosscheck_failed",
"document_invalid_issuance_or_expiration_date",
"document_possible_image_tampering",
"document_no_image_tampering",
"document_no_image_alteration_front",
"document_no_image_alteration_back",
"document_possible_image_alteration_front",
"document_possible_image_alteration_back",
"document_possible_image_alteration",
"document_possible_digital_fraud",
"document_selfie_used_with_different_information",
"document_selfie_mask",
"document_selfie_glasses",
"document_selfie_not_live_image",
"document_possible_fake_image",
"document_not_fake_image",
"document_pdf417_data_is_valid",
"document_pdf417_data_is_not_valid",
"document_photo_is_screen_capture",
"document_photo_is_not_screen_capture",
"document_photo_is_paper_capture",
"document_photo_is_not_paper_capture",
"document_alignment_failed",
"document_visible_photo_features_not_verified",
"document_mrz_line_format_check",
"document_qr_code_check",
"document_could_not_classify",
"document_visible_photo_features_verified",
"document_selfie_matches",
"document_selfie_does_not_match",
"document_selfie_bad_quality",
"document_type_mismatch",
"document_unknown_country_code",
"document_country_code_mismatch",
"document_is_permit_or_provisional_license",
"document_selfie_was_skipped",
"document_collected_via_desktop",
"document_not_live_capture",
"document_live_capture_failed",
"document_ocr_name_does_not_match",
"document_ocr_name_could_not_match",
"document_ocr_name_matches",
"document_ocr_address_does_not_match",
"document_ocr_address_could_not_match",
"document_ocr_address_matches",
"document_ocr_state_does_not_match",
"document_ocr_state_could_not_match",
"document_ocr_state_matches",
"document_ocr_first_name_does_not_match",
"document_ocr_first_name_matches",
"document_ocr_last_name_does_not_match",
"document_ocr_last_name_matches",
"document_ocr_dob_does_not_match",
"document_ocr_dob_could_not_match",
"document_ocr_dob_matches",
"document_dob_crosscheck_matches",
"document_dob_crosscheck_does_not_match",
"document_expiration_date_crosscheck_matches",
"document_expiration_date_crosscheck_does_not_match",
"document_sex_crosscheck_matches",
"document_sex_crosscheck_does_not_match",
"document_full_name_crosscheck_matches",
"document_full_name_crosscheck_does_not_match",
"document_number_crosscheck_matches",
"document_number_crosscheck_does_not_match",
"document_expiration_check_digit_matches",
"document_expiration_check_digit_does_not_match",
"document_dob_check_digit_matches",
"document_dob_check_digit_does_not_match",
"document_number_check_digit_matches",
"document_number_check_digit_does_not_match",
"curp_not_valid",
"curp_not_found",
"curp_valid",
"curp_input_curp_invalid",
"curp_could_not_validate",
"curp_multiple_results_for_data",
"curp_service_not_available",
"curp_malformed",
"address_matches",
"address_zip_code_matches",
"address_street_name_matches",
"address_street_number_matches",
"address_state_matches",
"dob_matches",
"dob_yob_matches",
"dob_mob_matches",
"ssn_matches",
"name_last_matches",
"name_first_matches",
"name_first_does_not_match",
"name_first_partially_matches",
"phone_number_matches",
"input_phone_number_matches_input_state",
"input_phone_number_matches_located_state_history",
"affiliated_with_broker_or_finra",
"visa_is_other",
"visa_expired_or_expiring_soon",
"strong_connection_to_labeled_fraud",
"medium_connection_to_labeled_fraud",
"strong_connection_to_labeled_active",
"medium_connection_to_labeled_active",
"strong_connection_to_labeled_offboard_other",
"medium_connection_to_labeled_offboard_other",
"user_is_labeled_fraud",
"beneficial_owner_is_labeled_fraud",
"business_name_match",
"business_name_similar_match",
"business_name_alternate_match",
"business_name_does_not_match",
"business_name_could_not_match",
"business_name_no_watchlist_hits",
"business_name_watchlist_hit",
"business_dba_match",
"business_dba_similar_match",
"business_dba_alternate_match",
"business_dba_does_not_match",
"business_phone_number_match",
"business_phone_number_does_not_match",
"business_website_online",
"business_website_offline",
"business_website_verified",
"business_website_unverified",
"business_website_parking_page",
"tin_match",
"tin_not_found",
"tin_invalid",
"tin_does_not_match",
"business_address_match",
"business_address_close_match",
"business_address_similar_match",
"business_address_incomplete_match",
"business_address_does_not_match",
"business_address_could_not_match",
"business_address_commercial",
"business_address_commercial_mail_receiving_agency",
"business_address_residential",
"business_address_deliverable",
"business_address_not_deliverable",
"business_address_is_po_box",
"beneficial_owners_match",
"beneficial_owners_partial_match",
"beneficial_owners_do_not_match",
"beneficial_owners_could_not_match",
"beneficial_owner_failed_kyc",
"beneficial_owner_possible_missing_bo",
"sos_active_filing_found",
"sos_filing_no_status",
"sos_filing_partially_active",
"sos_filing_no_active_found",
"sos_filing_not_found",
"sos_domestic_active_filing_found",
"sos_domestic_filing_no_status",
"sos_domestic_filing_inactive",
"sos_domestic_filing_not_found",
"sos_domestic_filing_status_good_standing",
"sos_domestic_filing_status_pending_active",
"sos_domestic_filing_status_pending_inactive",
"sos_domestic_filing_status_not_provided_by_state",
"sos_domestic_filing_status_not_in_good_standing",
"sos_domestic_filing_status_dissolved",
"sos_business_address_active_filing_found",
"sos_business_address_filing_status_not_available",
"sos_business_address_inactive_filing_found",
"sos_business_address_filing_not_found",
"device_low_risk",
"device_medium_risk",
"device_high_risk",
"device_factory_reset",
"device_gps_spoofing",
"ip_vpn",
"ip_tor_exit_node",
"device_bot_risk",
"device_suspicious",
"device_velocity",
"device_multiple_users",
"device_reputation",
"browser_incognito",
"browser_tampering",
"browser_automation",
"attested_device_apple",
"attested_device_android",
"attested_device_android_strong_integrity",
"attested_device_android_unlicensed",
"attested_device_android_risky",
"attested_device_android_failed_evaluation",
"attested_device_no_fraud_duplicate_risk",
"attested_device_fraud_duplicate_risk_low",
"attested_device_fraud_duplicate_risk_medium",
"attested_device_fraud_duplicate_risk_high",
"behavior_fraud_ring_risk",
"behavior_high_risk",
"behavior_low_risk",
"behavior_automatic_activity",
"ssn_miskeyed"
]
},
"GetBusinessVaultResponse": {
"example": {
"business.name": true,
"business.website": true,
"custom.account_id": true
},
"description": "A key-value map of identifier to whether the identifier exists in the business vault",
"type": "object",
"properties": {
"": {
"type": "string",
"enum": [
"business.name",
"business.dba",
"business.website",
"business.phone_number",
"business.tin",
"business.address_line1",
"business.address_line2",
"business.city",
"business.state",
"business.zip",
"business.country",
"business.beneficial_owners.*.ownership_stake",
"business.beneficial_owners.*.id.first_name",
"business.beneficial_owners.*.id.last_name",
"business.beneficial_owners.*.id.phone_number",
"business.beneficial_owners.*.id.email",
"business.beneficial_owner_explanation_message",
"business.corporation_type",
"business.formation_state",
"business.formation_date",
"custom.*"
]
},
"": {
"type": "boolean"
}
},
"required": [
"",
""
]
},
"GetFieldValidationResponse": {
"type": "object",
"properties": {
"address": {
"$ref": "#/components/schemas/FieldValidation"
},
"business_address": {
"$ref": "#/components/schemas/FieldValidation"
},
"business_beneficial_owners": {
"$ref": "#/components/schemas/FieldValidation"
},
"business_dba": {
"$ref": "#/components/schemas/FieldValidation"
},
"business_name": {
"$ref": "#/components/schemas/FieldValidation"
},
"business_phone_number": {
"$ref": "#/components/schemas/FieldValidation"
},
"business_tin": {
"$ref": "#/components/schemas/FieldValidation"
},
"dob": {
"$ref": "#/components/schemas/FieldValidation"
},
"document": {
"$ref": "#/components/schemas/FieldValidation"
},
"email": {
"$ref": "#/components/schemas/FieldValidation"
},
"name": {
"$ref": "#/components/schemas/FieldValidation"
},
"phone": {
"$ref": "#/components/schemas/FieldValidation"
},
"ssn": {
"$ref": "#/components/schemas/FieldValidation"
}
}
},
"GetUserVaultResponse": {
"example": {
"id.first_name": true,
"id.ssn9": true,
"custom.credit_card": true,
"id.dob": false
},
"description": "A key-value map of identifier to whether the identifier exists in the vault",
"type": "object",
"properties": {
"": {
"type": "string",
"enum": [
"id.first_name",
"id.middle_name",
"id.last_name",
"id.dob",
"id.ssn4",
"id.ssn9",
"id.address_line1",
"id.address_line2",
"id.city",
"id.state",
"id.zip",
"id.country",
"id.email",
"id.phone_number",
"id.us_legal_status",
"id.visa_kind",
"id.visa_expiration_date",
"id.nationality",
"id.citizenships",
"id.drivers_license_number",
"id.drivers_license_state",
"id.itin",
"id.us_tax_id",
"custom.*",
"investor_profile.employment_status",
"investor_profile.occupation",
"investor_profile.employer",
"investor_profile.annual_income",
"investor_profile.net_worth",
"investor_profile.investment_goals",
"investor_profile.risk_tolerance",
"investor_profile.declarations",
"investor_profile.brokerage_firm_employer",
"investor_profile.senior_executive_symbols",
"investor_profile.family_member_names",
"investor_profile.political_organization",
"investor_profile.funding_sources",
"document.id_card.front.image",
"document.id_card.front.latest_upload",
"document.id_card.front.mime_type",
"document.id_card.back.image",
"document.id_card.back.latest_upload",
"document.id_card.back.mime_type",
"document.id_card.selfie.image",
"document.id_card.selfie.latest_upload",
"document.id_card.selfie.mime_type",
"document.id_card.full_name",
"document.id_card.first_name",
"document.id_card.last_name",
"document.id_card.dob",
"document.id_card.gender",
"document.id_card.full_address",
"document.id_card.address_line1",
"document.id_card.city",
"document.id_card.state",
"document.id_card.country",
"document.id_card.postal_code",
"document.id_card.document_number",
"document.id_card.expires_at",
"document.id_card.issued_at",
"document.id_card.issuing_state",
"document.id_card.issuing_country",
"document.id_card.ref_number",
"document.id_card.nationality",
"document.id_card.curp",
"document.id_card.clave_de_elector",
"document.id_card.classified_document_type",
"document.id_card.curp_validation_response",
"document.id_card.samba_activity_history_response",
"document.id_card.us_issuing_state",
"document.drivers_license.front.image",
"document.drivers_license.front.latest_upload",
"document.drivers_license.front.mime_type",
"document.drivers_license.back.image",
"document.drivers_license.back.latest_upload",
"document.drivers_license.back.mime_type",
"document.drivers_license.selfie.image",
"document.drivers_license.selfie.latest_upload",
"document.drivers_license.selfie.mime_type",
"document.drivers_license.full_name",
"document.drivers_license.first_name",
"document.drivers_license.last_name",
"document.drivers_license.dob",
"document.drivers_license.gender",
"document.drivers_license.full_address",
"document.drivers_license.address_line1",
"document.drivers_license.city",
"document.drivers_license.state",
"document.drivers_license.country",
"document.drivers_license.postal_code",
"document.drivers_license.document_number",
"document.drivers_license.expires_at",
"document.drivers_license.issued_at",
"document.drivers_license.issuing_state",
"document.drivers_license.issuing_country",
"document.drivers_license.ref_number",
"document.drivers_license.nationality",
"document.drivers_license.curp",
"document.drivers_license.clave_de_elector",
"document.drivers_license.classified_document_type",
"document.drivers_license.curp_validation_response",
"document.drivers_license.samba_activity_history_response",
"document.drivers_license.us_issuing_state",
"document.passport.front.image",
"document.passport.front.latest_upload",
"document.passport.front.mime_type",
"document.passport.back.image",
"document.passport.back.latest_upload",
"document.passport.back.mime_type",
"document.passport.selfie.image",
"document.passport.selfie.latest_upload",
"document.passport.selfie.mime_type",
"document.passport.full_name",
"document.passport.first_name",
"document.passport.last_name",
"document.passport.dob",
"document.passport.gender",
"document.passport.full_address",
"document.passport.address_line1",
"document.passport.city",
"document.passport.state",
"document.passport.country",
"document.passport.postal_code",
"document.passport.document_number",
"document.passport.expires_at",
"document.passport.issued_at",
"document.passport.issuing_state",
"document.passport.issuing_country",
"document.passport.ref_number",
"document.passport.nationality",
"document.passport.curp",
"document.passport.clave_de_elector",
"document.passport.classified_document_type",
"document.passport.curp_validation_response",
"document.passport.samba_activity_history_response",
"document.passport.us_issuing_state",
"document.passport_card.front.image",
"document.passport_card.front.latest_upload",
"document.passport_card.front.mime_type",
"document.passport_card.back.image",
"document.passport_card.back.latest_upload",
"document.passport_card.back.mime_type",
"document.passport_card.selfie.image",
"document.passport_card.selfie.latest_upload",
"document.passport_card.selfie.mime_type",
"document.passport_card.full_name",
"document.passport_card.first_name",
"document.passport_card.last_name",
"document.passport_card.dob",
"document.passport_card.gender",
"document.passport_card.full_address",
"document.passport_card.address_line1",
"document.passport_card.city",
"document.passport_card.state",
"document.passport_card.country",
"document.passport_card.postal_code",
"document.passport_card.document_number",
"document.passport_card.expires_at",
"document.passport_card.issued_at",
"document.passport_card.issuing_state",
"document.passport_card.issuing_country",
"document.passport_card.ref_number",
"document.passport_card.nationality",
"document.passport_card.curp",
"document.passport_card.clave_de_elector",
"document.passport_card.classified_document_type",
"document.passport_card.curp_validation_response",
"document.passport_card.samba_activity_history_response",
"document.passport_card.us_issuing_state",
"document.permit.front.image",
"document.permit.front.latest_upload",
"document.permit.front.mime_type",
"document.permit.back.image",
"document.permit.back.latest_upload",
"document.permit.back.mime_type",
"document.permit.selfie.image",
"document.permit.selfie.latest_upload",
"document.permit.selfie.mime_type",
"document.permit.full_name",
"document.permit.first_name",
"document.permit.last_name",
"document.permit.dob",
"document.permit.gender",
"document.permit.full_address",
"document.permit.address_line1",
"document.permit.city",
"document.permit.state",
"document.permit.country",
"document.permit.postal_code",
"document.permit.document_number",
"document.permit.expires_at",
"document.permit.issued_at",
"document.permit.issuing_state",
"document.permit.issuing_country",
"document.permit.ref_number",
"document.permit.nationality",
"document.permit.curp",
"document.permit.clave_de_elector",
"document.permit.classified_document_type",
"document.permit.curp_validation_response",
"document.permit.samba_activity_history_response",
"document.permit.us_issuing_state",
"document.visa.front.image",
"document.visa.front.latest_upload",
"document.visa.front.mime_type",
"document.visa.back.image",
"document.visa.back.latest_upload",
"document.visa.back.mime_type",
"document.visa.selfie.image",
"document.visa.selfie.latest_upload",
"document.visa.selfie.mime_type",
"document.visa.full_name",
"document.visa.first_name",
"document.visa.last_name",
"document.visa.dob",
"document.visa.gender",
"document.visa.full_address",
"document.visa.address_line1",
"document.visa.city",
"document.visa.state",
"document.visa.country",
"document.visa.postal_code",
"document.visa.document_number",
"document.visa.expires_at",
"document.visa.issued_at",
"document.visa.issuing_state",
"document.visa.issuing_country",
"document.visa.ref_number",
"document.visa.nationality",
"document.visa.curp",
"document.visa.clave_de_elector",
"document.visa.classified_document_type",
"document.visa.curp_validation_response",
"document.visa.samba_activity_history_response",
"document.visa.us_issuing_state",
"document.residence_document.front.image",
"document.residence_document.front.latest_upload",
"document.residence_document.front.mime_type",
"document.residence_document.back.image",
"document.residence_document.back.latest_upload",
"document.residence_document.back.mime_type",
"document.residence_document.selfie.image",
"document.residence_document.selfie.latest_upload",
"document.residence_document.selfie.mime_type",
"document.residence_document.full_name",
"document.residence_document.first_name",
"document.residence_document.last_name",
"document.residence_document.dob",
"document.residence_document.gender",
"document.residence_document.full_address",
"document.residence_document.address_line1",
"document.residence_document.city",
"document.residence_document.state",
"document.residence_document.country",
"document.residence_document.postal_code",
"document.residence_document.document_number",
"document.residence_document.expires_at",
"document.residence_document.issued_at",
"document.residence_document.issuing_state",
"document.residence_document.issuing_country",
"document.residence_document.ref_number",
"document.residence_document.nationality",
"document.residence_document.curp",
"document.residence_document.clave_de_elector",
"document.residence_document.classified_document_type",
"document.residence_document.curp_validation_response",
"document.residence_document.samba_activity_history_response",
"document.residence_document.us_issuing_state",
"document.voter_identification.front.image",
"document.voter_identification.front.latest_upload",
"document.voter_identification.front.mime_type",
"document.voter_identification.back.image",
"document.voter_identification.back.latest_upload",
"document.voter_identification.back.mime_type",
"document.voter_identification.selfie.image",
"document.voter_identification.selfie.latest_upload",
"document.voter_identification.selfie.mime_type",
"document.voter_identification.full_name",
"document.voter_identification.first_name",
"document.voter_identification.last_name",
"document.voter_identification.dob",
"document.voter_identification.gender",
"document.voter_identification.full_address",
"document.voter_identification.address_line1",
"document.voter_identification.city",
"document.voter_identification.state",
"document.voter_identification.country",
"document.voter_identification.postal_code",
"document.voter_identification.document_number",
"document.voter_identification.expires_at",
"document.voter_identification.issued_at",
"document.voter_identification.issuing_state",
"document.voter_identification.issuing_country",
"document.voter_identification.ref_number",
"document.voter_identification.nationality",
"document.voter_identification.curp",
"document.voter_identification.clave_de_elector",
"document.voter_identification.classified_document_type",
"document.voter_identification.curp_validation_response",
"document.voter_identification.samba_activity_history_response",
"document.voter_identification.us_issuing_state",
"document.finra_compliance_letter",
"document.proof_of_address.image",
"document.ssn_card.image",
"document.custom.*",
"card.*.number",
"card.*.expiration",
"card.*.cvc",
"card.*.name",
"card.*.billing_address.zip",
"card.*.billing_address.country",
"card.*.expiration_month",
"card.*.expiration_year",
"card.*.number_last4",
"card.*.issuer",
"card.*.fingerprint",
"bank.*.name",
"bank.*.ach_routing_number",
"bank.*.ach_wire_routing_number",
"bank.*.ach_account_number",
"bank.*.ach_account_id",
"bank.*.account_type",
"bank.*.institution_id",
"bank.*.institution_name",
"bank.*.account_last4",
"bank.*.iban",
"bank.*.bic",
"bank.*.owners",
"bank.*.mk_link_id",
"bank.*.link_id",
"bank.*.closed",
"bank.*.fingerprint"
]
},
"": {
"type": "boolean"
}
},
"required": [
"",
""
]
},
"IdDocKind": {
"description": "This is the set of document kinds that are verifiable with incode. They are govt-issued docs,\n and they all support having a selfie uploaded alongside them.",
"type": "string",
"enum": [
"id_card",
"drivers_license",
"passport",
"passport_card",
"permit",
"visa",
"residence_document",
"voter_identification"
]
},
"IdentityDocumentData": {
"type": "object",
"properties": {
"country_code": {
"allOf": [
{
"$ref": "#/components/schemas/Iso3166TwoDigitCountryCode"
},
{
"description": "The country code of the identity document\n If not provided, `US` will be used as the default country code.",
"type": "string"
}
]
},
"data": {
"allOf": [
{
"$ref": "#/components/schemas/DocumentDataForRequest"
},
{
"description": "The vault identifiers of the document and optional selfie images. If not provided, the\n image locations will be inferred from the document_kind. If provided, the expected document\n kind will be inferred from the vault identifiers.",
"type": "object"
}
]
},
"document_fixture_result": {
"allOf": [
{
"$ref": "#/components/schemas/DocumentFixtureResult"
},
{
"description": "Only valid in sandbox mode.\n If provided, the document will be created with the provided fixture result.",
"type": "string"
}
]
},
"document_kind": {
"allOf": [
{
"$ref": "#/components/schemas/IdDocKind"
},
{
"description": "The document kind to use in the playbook verification request\n This document will need to be in the vault or else\n the request will fail\n Note: this is not used if `data` is provided and will be deprecated in the future",
"type": "string"
}
]
}
},
"required": [
"document_kind"
]
},
"ImportAccount": {
"type": "object",
"properties": {
"account_id": {
"description": "Your internal ID for this account. Must be unique within the imported account batch.",
"type": "string"
},
"account_type": {
"allOf": [
{
"$ref": "#/components/schemas/BankAccountType"
},
{
"description": "The type of the account",
"type": "object"
}
]
},
"balances": {
"allOf": [
{
"$ref": "#/components/schemas/ImportBalances"
},
{
"description": "The balances of the account",
"type": "object"
}
]
},
"name": {
"description": "The name of the account",
"type": "string"
}
},
"required": [
"account_id",
"account_type",
"balances",
"name"
]
},
"ImportBalances": {
"type": "object",
"properties": {
"available": {
"example": "1200.00",
"description": "The available balance",
"type": "number",
"format": "double"
},
"balance_date": {
"example": "2023-05-15T14:30:00Z",
"description": "The date the balance was captured at",
"type": "string",
"format": "date-time"
},
"currency": {
"example": "USD",
"description": "The currency of the account (ISO-4217)",
"type": "string"
},
"current": {
"example": "1250.45",
"description": "The current balance",
"type": "number",
"format": "double"
},
"limit": {
"example": "2000.00",
"description": "The limit",
"type": "number",
"format": "double"
}
},
"required": [
"currency"
]
},
"ImportLinkRequest": {
"type": "object",
"properties": {
"accounts": {
"description": "List of accounts to import",
"type": "array",
"items": {
"$ref": "#/components/schemas/ImportAccount"
}
},
"external_id": {
"description": "An optional external id for the link",
"type": "string"
},
"institution_id": {
"description": "The institution id of the link",
"type": "string"
},
"provider": {
"allOf": [
{
"$ref": "#/components/schemas/Provider"
},
{
"description": "The provider that you are importing from",
"type": "string"
}
]
},
"transactions": {
"description": "List of transactions to import",
"type": "array",
"items": {
"$ref": "#/components/schemas/ImportTransaction"
}
}
},
"required": [
"accounts",
"institution_id",
"transactions"
]
},
"ImportTransaction": {
"type": "object",
"properties": {
"account_id": {
"description": "The internal account ID associated with this transaction",
"type": "string"
},
"amount": {
"description": "The amount of the transaction",
"type": "string"
},
"date": {
"description": "The date of the transaction in ISO-8601 format",
"type": "string"
},
"description": {
"description": "The description of the transaction",
"type": "string"
},
"transaction_id": {
"description": "The transaction ID",
"type": "string"
},
"transaction_type": {
"description": "The type of the transaction",
"type": "string"
}
},
"required": [
"account_id",
"amount",
"date"
]
},
"ImportTransactionsRequest": {
"type": "object",
"properties": {
"transactions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ImportTransaction"
}
}
},
"required": [
"transactions"
]
},
"InputOnboardingData": {
"type": "object"
},
"InsightAddress": {
"description": "An address associated with the business.",
"type": "object",
"properties": {
"address_line1": {
"description": "Primary street address line.",
"type": "string"
},
"address_line2": {
"description": "Secondary address line (suite, unit, etc.).",
"type": "string"
},
"city": {
"description": "City name.",
"type": "string"
},
"cmra": {
"description": "Whether this address is a Commercial Mail Receiving Agency (CMRA),\n such as a UPS Store or similar mailbox service.",
"type": "boolean"
},
"deliverable": {
"description": "Whether this address is deliverable by USPS.",
"type": "boolean"
},
"latitude": {
"description": "Latitude coordinate of the address.",
"type": "number",
"format": "double"
},
"longitude": {
"description": "Longitude coordinate of the address.",
"type": "number",
"format": "double"
},
"postal_code": {
"description": "Postal or ZIP code.",
"type": "string"
},
"property_type": {
"description": "Property type classification (e.g. commercial, residential).",
"type": "string"
},
"sources": {
"description": "Sources where this address was found during verification.",
"type": "string"
},
"state": {
"description": "U.S. state or region.",
"type": "string"
},
"submitted": {
"description": "Whether this address was submitted as part of the onboarding flow.",
"type": "boolean"
},
"verified": {
"description": "Whether this address was verified.",
"type": "boolean"
}
}
},
"InsightBusinessDetail": {
"description": "General details about the business entity.",
"type": "object",
"properties": {
"entity_type": {
"description": "The type of business entity (e.g. LLC, Corporation), if available.",
"type": "string"
},
"formation_date": {
"description": "Date the business was formed, if available.",
"type": "string"
},
"formation_state": {
"description": "U.S. state (or jurisdiction) where the business was formed, if\n available.",
"type": "string"
},
"phone_numbers": {
"description": "Phone numbers associated with the business and their verification\n status.",
"type": "array",
"items": {
"$ref": "#/components/schemas/InsightPhone"
}
},
"tin": {
"allOf": [
{
"$ref": "#/components/schemas/InsightTin"
},
{
"description": "Information about the business's Taxpayer Identification Number (TIN).",
"type": "object"
}
]
},
"website": {
"allOf": [
{
"$ref": "#/components/schemas/InsightWebsite"
},
{
"description": "Website associated with the business and its verification status.",
"type": "object"
}
]
}
},
"required": [
"phone_numbers"
]
},
"InsightBusinessName": {
"description": "A business name and its verification status.",
"type": "object",
"properties": {
"kind": {
"description": "The type of business name, e.g. `\"dba\"` or `\"legal\"`.",
"type": "string"
},
"name": {
"description": "The business name.",
"type": "string"
},
"sources": {
"description": "Sources where this name was found during verification. Does not include\n watchlist information.",
"type": "string"
},
"sub_status": {
"description": "A more granular verification status for this name.",
"type": "string"
},
"submitted": {
"description": "Whether this name was submitted as part of the onboarding flow (as\n opposed to being discovered during verification).",
"type": "boolean"
},
"verified": {
"description": "Whether this name was verified. `None` if verification was not\n attempted.",
"type": "boolean"
}
},
"required": [
"submitted"
]
},
"InsightEvent": {
"type": "object",
"properties": {
"city": {
"example": "San Francisco",
"type": "string"
},
"country": {
"example": "US",
"type": "string"
},
"ip_address": {
"type": "string"
},
"latitude": {
"type": "number",
"format": "double"
},
"longitude": {
"type": "number",
"format": "double"
},
"metro_code": {
"type": "string"
},
"postal_code": {
"example": "94117",
"type": "string"
},
"region": {
"example": "CA",
"type": "string"
},
"region_name": {
"type": "string"
},
"session_id": {
"type": "string"
},
"time_zone": {
"type": "string"
},
"timestamp": {
"type": "string",
"format": "date-time"
},
"user_agent": {
"example": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/18.0.1 Safari/605.1.15",
"type": "string"
}
},
"required": [
"timestamp"
]
},
"InsightPerson": {
"description": "A person associated with the business.",
"type": "object",
"properties": {
"association_verified": {
"description": "Whether this person's association with the business was verified.\n `None` if verification was not attempted.",
"type": "boolean"
},
"name": {
"description": "Full name of the person.",
"type": "string"
},
"role": {
"description": "The person's role at the business (e.g. officer, director, beneficial\n owner).",
"type": "string"
},
"sources": {
"description": "Sources where this person was found during verification.",
"type": "string"
},
"submitted": {
"description": "Whether this person was submitted as part of the onboarding flow (as\n opposed to being discovered through public records or other sources).",
"type": "boolean"
}
},
"required": [
"submitted"
]
},
"InsightPhone": {
"description": "A phone number associated with the business.",
"type": "object",
"properties": {
"phone": {
"description": "The phone number.",
"type": "string"
},
"submitted": {
"description": "Whether this phone number was submitted as part of the onboarding flow.",
"type": "boolean"
},
"verified": {
"description": "Whether this phone number's association with the business was verified.",
"type": "boolean"
}
},
"required": [
"phone"
]
},
"InsightRegistration": {
"description": "A governmental registration record for the business.",
"type": "object",
"properties": {
"addresses": {
"description": "Addresses listed on the registration.",
"type": "array",
"items": {
"type": "string"
}
},
"entity_type": {
"description": "Entity type as listed on the registration (e.g. LLC, Corporation).",
"type": "string"
},
"file_number": {
"description": "The filing or registration number assigned by the registering body.",
"type": "string"
},
"jurisdiction": {
"description": "The jurisdiction under which the business is registered.",
"type": "string"
},
"name": {
"description": "The business name as it appears on the registration.",
"type": "string"
},
"officers": {
"description": "Officers listed on the registration.",
"type": "array",
"items": {
"$ref": "#/components/schemas/Officer"
}
},
"registered_agent": {
"description": "Name of the registered agent on file.",
"type": "string"
},
"registration_date": {
"description": "Date the registration was filed.",
"type": "string"
},
"source": {
"description": "The source or agency that provided this registration record.",
"type": "string"
},
"state": {
"description": "U.S. state where the registration was filed.",
"type": "string"
},
"status": {
"description": "Current status of the registration (e.g. active, inactive).",
"type": "string"
},
"sub_status": {
"description": "More granular status of the registration.",
"type": "string"
}
},
"required": [
"addresses",
"officers"
]
},
"InsightTin": {
"description": "Taxpayer Identification Number (TIN) verification result.",
"type": "object",
"properties": {
"potential_match": {
"description": "If the submitted TIN was not found, this contains the closest matching\n TIN from the IRS database, if one exists.",
"type": "string"
},
"tin": {
"description": "The TIN that was verified.",
"type": "string"
},
"verified": {
"description": "Whether the TIN was verified against the IRS database.",
"type": "boolean"
}
},
"required": [
"verified"
]
},
"InsightWatchlist": {
"description": "Watchlist screening results for the business and associated people.",
"type": "object",
"properties": {
"business": {
"description": "Watchlist screening results for business names.",
"type": "array",
"items": {
"$ref": "#/components/schemas/WatchlistEntry"
}
},
"hit_count": {
"description": "Total number of watchlist hits across all screened entities.",
"type": "integer",
"format": "int64"
},
"people": {
"description": "Watchlist screening results for people associated with the business.",
"type": "array",
"items": {
"$ref": "#/components/schemas/WatchlistEntry"
}
}
},
"required": [
"business",
"people"
]
},
"InsightWebsite": {
"description": "A website associated with the business.",
"type": "object",
"properties": {
"url": {
"description": "The website URL.",
"type": "string"
},
"verified": {
"description": "Whether this website's association with the business was verified.",
"type": "boolean"
}
},
"required": [
"url"
]
},
"IntegrityRequest": {
"type": "object",
"properties": {
"fields": {
"description": "List of data identifiers to decrypt. For example, `id.first_name`, `id.ssn4`,\n `custom.bank_account`",
"type": "array",
"items": {
"$ref": "#/components/schemas/UserDataIdentifier"
}
},
"signing_key": {
"description": "A hex-encoded key for computing `hmac-sha256` signatures",
"type": "string"
}
},
"required": [
"signing_key"
]
},
"IntegrityResponse": {
"example": {
"id.last_name": "f7ee801830...",
"id.ssn9": "1cefe40fa...",
"custom.credit_card": "f7dbdc6..."
},
"description": "A key-value map with the corresponding hex-encoded hash values",
"type": "object",
"properties": {
"": {
"type": "string",
"enum": [
"id.first_name",
"id.middle_name",
"id.last_name",
"id.dob",
"id.ssn4",
"id.ssn9",
"id.address_line1",
"id.address_line2",
"id.city",
"id.state",
"id.zip",
"id.country",
"id.email",
"id.phone_number",
"id.us_legal_status",
"id.visa_kind",
"id.visa_expiration_date",
"id.nationality",
"id.citizenships",
"id.drivers_license_number",
"id.drivers_license_state",
"id.itin",
"id.us_tax_id",
"custom.*",
"investor_profile.employment_status",
"investor_profile.occupation",
"investor_profile.employer",
"investor_profile.annual_income",
"investor_profile.net_worth",
"investor_profile.investment_goals",
"investor_profile.risk_tolerance",
"investor_profile.declarations",
"investor_profile.brokerage_firm_employer",
"investor_profile.senior_executive_symbols",
"investor_profile.family_member_names",
"investor_profile.political_organization",
"investor_profile.funding_sources",
"document.id_card.front.image",
"document.id_card.front.latest_upload",
"document.id_card.front.mime_type",
"document.id_card.back.image",
"document.id_card.back.latest_upload",
"document.id_card.back.mime_type",
"document.id_card.selfie.image",
"document.id_card.selfie.latest_upload",
"document.id_card.selfie.mime_type",
"document.id_card.full_name",
"document.id_card.first_name",
"document.id_card.last_name",
"document.id_card.dob",
"document.id_card.gender",
"document.id_card.full_address",
"document.id_card.address_line1",
"document.id_card.city",
"document.id_card.state",
"document.id_card.country",
"document.id_card.postal_code",
"document.id_card.document_number",
"document.id_card.expires_at",
"document.id_card.issued_at",
"document.id_card.issuing_state",
"document.id_card.issuing_country",
"document.id_card.ref_number",
"document.id_card.nationality",
"document.id_card.curp",
"document.id_card.clave_de_elector",
"document.id_card.classified_document_type",
"document.id_card.curp_validation_response",
"document.id_card.samba_activity_history_response",
"document.id_card.us_issuing_state",
"document.drivers_license.front.image",
"document.drivers_license.front.latest_upload",
"document.drivers_license.front.mime_type",
"document.drivers_license.back.image",
"document.drivers_license.back.latest_upload",
"document.drivers_license.back.mime_type",
"document.drivers_license.selfie.image",
"document.drivers_license.selfie.latest_upload",
"document.drivers_license.selfie.mime_type",
"document.drivers_license.full_name",
"document.drivers_license.first_name",
"document.drivers_license.last_name",
"document.drivers_license.dob",
"document.drivers_license.gender",
"document.drivers_license.full_address",
"document.drivers_license.address_line1",
"document.drivers_license.city",
"document.drivers_license.state",
"document.drivers_license.country",
"document.drivers_license.postal_code",
"document.drivers_license.document_number",
"document.drivers_license.expires_at",
"document.drivers_license.issued_at",
"document.drivers_license.issuing_state",
"document.drivers_license.issuing_country",
"document.drivers_license.ref_number",
"document.drivers_license.nationality",
"document.drivers_license.curp",
"document.drivers_license.clave_de_elector",
"document.drivers_license.classified_document_type",
"document.drivers_license.curp_validation_response",
"document.drivers_license.samba_activity_history_response",
"document.drivers_license.us_issuing_state",
"document.passport.front.image",
"document.passport.front.latest_upload",
"document.passport.front.mime_type",
"document.passport.back.image",
"document.passport.back.latest_upload",
"document.passport.back.mime_type",
"document.passport.selfie.image",
"document.passport.selfie.latest_upload",
"document.passport.selfie.mime_type",
"document.passport.full_name",
"document.passport.first_name",
"document.passport.last_name",
"document.passport.dob",
"document.passport.gender",
"document.passport.full_address",
"document.passport.address_line1",
"document.passport.city",
"document.passport.state",
"document.passport.country",
"document.passport.postal_code",
"document.passport.document_number",
"document.passport.expires_at",
"document.passport.issued_at",
"document.passport.issuing_state",
"document.passport.issuing_country",
"document.passport.ref_number",
"document.passport.nationality",
"document.passport.curp",
"document.passport.clave_de_elector",
"document.passport.classified_document_type",
"document.passport.curp_validation_response",
"document.passport.samba_activity_history_response",
"document.passport.us_issuing_state",
"document.passport_card.front.image",
"document.passport_card.front.latest_upload",
"document.passport_card.front.mime_type",
"document.passport_card.back.image",
"document.passport_card.back.latest_upload",
"document.passport_card.back.mime_type",
"document.passport_card.selfie.image",
"document.passport_card.selfie.latest_upload",
"document.passport_card.selfie.mime_type",
"document.passport_card.full_name",
"document.passport_card.first_name",
"document.passport_card.last_name",
"document.passport_card.dob",
"document.passport_card.gender",
"document.passport_card.full_address",
"document.passport_card.address_line1",
"document.passport_card.city",
"document.passport_card.state",
"document.passport_card.country",
"document.passport_card.postal_code",
"document.passport_card.document_number",
"document.passport_card.expires_at",
"document.passport_card.issued_at",
"document.passport_card.issuing_state",
"document.passport_card.issuing_country",
"document.passport_card.ref_number",
"document.passport_card.nationality",
"document.passport_card.curp",
"document.passport_card.clave_de_elector",
"document.passport_card.classified_document_type",
"document.passport_card.curp_validation_response",
"document.passport_card.samba_activity_history_response",
"document.passport_card.us_issuing_state",
"document.permit.front.image",
"document.permit.front.latest_upload",
"document.permit.front.mime_type",
"document.permit.back.image",
"document.permit.back.latest_upload",
"document.permit.back.mime_type",
"document.permit.selfie.image",
"document.permit.selfie.latest_upload",
"document.permit.selfie.mime_type",
"document.permit.full_name",
"document.permit.first_name",
"document.permit.last_name",
"document.permit.dob",
"document.permit.gender",
"document.permit.full_address",
"document.permit.address_line1",
"document.permit.city",
"document.permit.state",
"document.permit.country",
"document.permit.postal_code",
"document.permit.document_number",
"document.permit.expires_at",
"document.permit.issued_at",
"document.permit.issuing_state",
"document.permit.issuing_country",
"document.permit.ref_number",
"document.permit.nationality",
"document.permit.curp",
"document.permit.clave_de_elector",
"document.permit.classified_document_type",
"document.permit.curp_validation_response",
"document.permit.samba_activity_history_response",
"document.permit.us_issuing_state",
"document.visa.front.image",
"document.visa.front.latest_upload",
"document.visa.front.mime_type",
"document.visa.back.image",
"document.visa.back.latest_upload",
"document.visa.back.mime_type",
"document.visa.selfie.image",
"document.visa.selfie.latest_upload",
"document.visa.selfie.mime_type",
"document.visa.full_name",
"document.visa.first_name",
"document.visa.last_name",
"document.visa.dob",
"document.visa.gender",
"document.visa.full_address",
"document.visa.address_line1",
"document.visa.city",
"document.visa.state",
"document.visa.country",
"document.visa.postal_code",
"document.visa.document_number",
"document.visa.expires_at",
"document.visa.issued_at",
"document.visa.issuing_state",
"document.visa.issuing_country",
"document.visa.ref_number",
"document.visa.nationality",
"document.visa.curp",
"document.visa.clave_de_elector",
"document.visa.classified_document_type",
"document.visa.curp_validation_response",
"document.visa.samba_activity_history_response",
"document.visa.us_issuing_state",
"document.residence_document.front.image",
"document.residence_document.front.latest_upload",
"document.residence_document.front.mime_type",
"document.residence_document.back.image",
"document.residence_document.back.latest_upload",
"document.residence_document.back.mime_type",
"document.residence_document.selfie.image",
"document.residence_document.selfie.latest_upload",
"document.residence_document.selfie.mime_type",
"document.residence_document.full_name",
"document.residence_document.first_name",
"document.residence_document.last_name",
"document.residence_document.dob",
"document.residence_document.gender",
"document.residence_document.full_address",
"document.residence_document.address_line1",
"document.residence_document.city",
"document.residence_document.state",
"document.residence_document.country",
"document.residence_document.postal_code",
"document.residence_document.document_number",
"document.residence_document.expires_at",
"document.residence_document.issued_at",
"document.residence_document.issuing_state",
"document.residence_document.issuing_country",
"document.residence_document.ref_number",
"document.residence_document.nationality",
"document.residence_document.curp",
"document.residence_document.clave_de_elector",
"document.residence_document.classified_document_type",
"document.residence_document.curp_validation_response",
"document.residence_document.samba_activity_history_response",
"document.residence_document.us_issuing_state",
"document.voter_identification.front.image",
"document.voter_identification.front.latest_upload",
"document.voter_identification.front.mime_type",
"document.voter_identification.back.image",
"document.voter_identification.back.latest_upload",
"document.voter_identification.back.mime_type",
"document.voter_identification.selfie.image",
"document.voter_identification.selfie.latest_upload",
"document.voter_identification.selfie.mime_type",
"document.voter_identification.full_name",
"document.voter_identification.first_name",
"document.voter_identification.last_name",
"document.voter_identification.dob",
"document.voter_identification.gender",
"document.voter_identification.full_address",
"document.voter_identification.address_line1",
"document.voter_identification.city",
"document.voter_identification.state",
"document.voter_identification.country",
"document.voter_identification.postal_code",
"document.voter_identification.document_number",
"document.voter_identification.expires_at",
"document.voter_identification.issued_at",
"document.voter_identification.issuing_state",
"document.voter_identification.issuing_country",
"document.voter_identification.ref_number",
"document.voter_identification.nationality",
"document.voter_identification.curp",
"document.voter_identification.clave_de_elector",
"document.voter_identification.classified_document_type",
"document.voter_identification.curp_validation_response",
"document.voter_identification.samba_activity_history_response",
"document.voter_identification.us_issuing_state",
"document.finra_compliance_letter",
"document.proof_of_address.image",
"document.ssn_card.image",
"document.custom.*",
"card.*.number",
"card.*.expiration",
"card.*.cvc",
"card.*.name",
"card.*.billing_address.zip",
"card.*.billing_address.country",
"card.*.expiration_month",
"card.*.expiration_year",
"card.*.number_last4",
"card.*.issuer",
"card.*.fingerprint",
"bank.*.name",
"bank.*.ach_routing_number",
"bank.*.ach_wire_routing_number",
"bank.*.ach_account_number",
"bank.*.ach_account_id",
"bank.*.account_type",
"bank.*.institution_id",
"bank.*.institution_name",
"bank.*.account_last4",
"bank.*.iban",
"bank.*.bic",
"bank.*.owners",
"bank.*.mk_link_id",
"bank.*.link_id",
"bank.*.closed",
"bank.*.fingerprint"
]
},
"": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer",
"format": "int64"
},
{
"type": "boolean"
},
{
"type": "object"
}
]
}
},
"required": [
"",
""
]
},
"InvestmentHolding": {
"type": "object",
"properties": {
"account_id": {
"example": "acc_12345678",
"description": "The account ID",
"type": "string"
},
"cost_basis": {
"example": 1507.5,
"description": "The holding cost basis",
"type": "string"
},
"price": {
"example": 160.0,
"description": "The price of the security",
"type": "string"
},
"price_datetime": {
"example": "2023-05-15T16:00:00Z",
"description": "The price datetime",
"type": "string"
},
"quantity": {
"example": 10,
"description": "The holding quantity",
"type": "string"
},
"security_id": {
"example": "sec_aapl",
"description": "The security ID",
"type": "string"
},
"value": {
"example": 1600.0,
"description": "The value of the holding",
"type": "string"
}
},
"required": [
"account_id",
"quantity",
"security_id"
]
},
"InvestmentTransaction": {
"type": "object",
"properties": {
"account_id": {
"example": "acc_12345678",
"description": "The account ID",
"type": "string"
},
"amount": {
"example": 1000.0,
"description": "The transaction amount",
"type": "string"
},
"date": {
"example": "2023-05-15",
"description": "The transaction date",
"type": "string"
},
"datetime": {
"example": "2023-05-15T14:30:00Z",
"description": "The transaction datetime (if available)",
"type": "string",
"format": "date-time"
},
"description": {
"example": "BUY 10 AAPL",
"description": "The transaction description",
"type": "string"
},
"fees": {
"example": 4.99,
"description": "The fees associated with the transaction",
"type": "string"
},
"forex_rate": {
"example": 1.0,
"description": "The forex rate",
"type": "string"
},
"investment_transaction_id": {
"example": "inv_txn_abcdefgh1234",
"description": "The transaction ID",
"type": "string"
},
"price": {
"example": 150.75,
"description": "The price of the security",
"type": "string"
},
"quantity": {
"example": 10,
"description": "The quantity of the security",
"type": "string"
},
"security_id": {
"example": "sec_aapl",
"description": "The security ID",
"type": "string"
},
"type": {
"example": "buy",
"description": "The transaction type",
"type": "string"
}
},
"required": [
"account_id",
"amount",
"date",
"description",
"investment_transaction_id",
"type"
]
},
"Iso3166TwoDigitCountryCode": {
"type": "string",
"enum": [
"US",
"AD",
"AE",
"AF",
"AG",
"AI",
"AL",
"AM",
"AO",
"AQ",
"AR",
"AS",
"AT",
"AU",
"AW",
"AX",
"AZ",
"BA",
"BB",
"BD",
"BE",
"BF",
"BG",
"BH",
"BI",
"BJ",
"BL",
"BM",
"BN",
"BO",
"BQ",
"BR",
"BS",
"BT",
"BV",
"BW",
"BY",
"BZ",
"CA",
"CC",
"CD",
"CF",
"CG",
"CH",
"CI",
"CK",
"CL",
"CM",
"CN",
"CO",
"CR",
"CU",
"CV",
"CW",
"CX",
"CY",
"CZ",
"DE",
"DJ",
"DK",
"DM",
"DO",
"DZ",
"EC",
"EE",
"EG",
"EH",
"ER",
"ES",
"ET",
"FI",
"FJ",
"FK",
"FM",
"FO",
"FR",
"GA",
"GB",
"GD",
"GE",
"GF",
"GG",
"GH",
"GI",
"GL",
"GM",
"GN",
"GP",
"GQ",
"GR",
"GS",
"GT",
"GU",
"GW",
"GY",
"HK",
"HM",
"HN",
"HR",
"HT",
"HU",
"ID",
"IE",
"IL",
"IM",
"IN",
"IO",
"IQ",
"IR",
"IS",
"IT",
"JE",
"JM",
"JO",
"JP",
"KE",
"KG",
"KH",
"KI",
"KM",
"KN",
"KP",
"KR",
"KW",
"KY",
"KZ",
"LA",
"LB",
"LC",
"LI",
"LK",
"LR",
"LS",
"LT",
"LU",
"LV",
"LY",
"MA",
"MC",
"MD",
"ME",
"MF",
"MG",
"MH",
"MK",
"ML",
"MM",
"MN",
"MO",
"MP",
"MQ",
"MR",
"MS",
"MT",
"MU",
"MV",
"MW",
"MX",
"MY",
"MZ",
"NA",
"NC",
"NE",
"NF",
"NG",
"NI",
"NL",
"NO",
"NP",
"NR",
"NU",
"NZ",
"OM",
"PA",
"PE",
"PF",
"PG",
"PH",
"PK",
"PL",
"PM",
"PN",
"PR",
"PS",
"PT",
"PW",
"PY",
"QA",
"RE",
"RO",
"RS",
"RU",
"RW",
"SA",
"SB",
"SC",
"SD",
"SE",
"SG",
"SH",
"SI",
"SJ",
"SK",
"SL",
"SM",
"SN",
"SO",
"SR",
"SS",
"ST",
"SV",
"SX",
"SY",
"SZ",
"TC",
"TD",
"TF",
"TG",
"TH",
"TJ",
"TK",
"TL",
"TM",
"TN",
"TO",
"TR",
"TT",
"TV",
"TW",
"TZ",
"UA",
"UG",
"UM",
"UY",
"UZ",
"VA",
"VC",
"VE",
"VG",
"VI",
"VN",
"VU",
"WF",
"WS",
"YE",
"YT",
"ZA",
"ZM",
"ZW",
"XK"
]
},
"LabelKind": {
"type": "string",
"enum": [
"active",
"offboard_fraud",
"offboard_other"
]
},
"Link": {
"type": "object",
"properties": {
"available_products": {
"description": "The available productions for the link",
"type": "array",
"items": {
"$ref": "#/components/schemas/Product"
}
},
"created_at": {
"example": "2021-01-01T00:00:00Z",
"description": "The date and time the link was created",
"type": "string",
"format": "date-time"
},
"error_code": {
"allOf": [
{
"$ref": "#/components/schemas/LinkError"
},
{
"example": null,
"description": "The error code",
"type": "string"
}
]
},
"external_id": {
"example": "ext_id_12345678",
"description": "The external id of the link",
"type": "string"
},
"fp_id": {
"description": "The footprint entity owning the link",
"type": "string"
},
"id": {
"example": "bank_link_x134ssf3rsdf",
"description": "The link ID",
"type": "string"
},
"institution_id": {
"example": "inst_12345",
"description": "The institution ID",
"type": "string"
},
"institution_logo": {
"example": "https://example.com/chase.png",
"description": "The institution logo",
"type": "string"
},
"institution_name": {
"example": "Chase Bank",
"description": "The account name",
"type": "string"
},
"products": {
"allOf": [
{
"$ref": "#/components/schemas/ProductStatuses"
},
{
"description": "The products added to the link and their statuses",
"type": "object"
}
]
},
"provider": {
"example": "akoya",
"description": "The underlying data provider used to establish the link",
"type": "string"
},
"state": {
"allOf": [
{
"$ref": "#/components/schemas/LinkState"
},
{
"example": "connected",
"description": "The link state",
"type": "string"
}
]
}
},
"required": [
"available_products",
"created_at",
"fp_id",
"id",
"products",
"state"
]
},
"LinkError": {
"type": "string",
"enum": [
"system_error",
"provider_error",
"institution_error",
"user_error",
"auth_expired",
"no_accounts",
"user_setup_required",
"invalid_credentials",
"user_oauth_denied",
"user_input_incorrect",
"incomplete"
]
},
"LinkInfo": {
"type": "object",
"properties": {
"created_at": {
"description": "The datetime the link was created",
"type": "string",
"format": "date-time"
},
"external_id": {
"example": "ext_id_12345678",
"description": "The external id of the link",
"type": "string"
},
"fp_id": {
"example": "fp_id_12345678",
"description": "The footprint entity owning the link",
"type": "string"
},
"id": {
"example": "bal_x134ssf3rsdf",
"description": "The link ID",
"type": "string"
}
},
"required": [
"created_at",
"fp_id",
"id"
]
},
"LinkProductRefresh": {
"type": "object",
"properties": {
"product": {
"allOf": [
{
"$ref": "#/components/schemas/BankLinkProduct"
},
{
"description": "the product that was updated",
"type": "object"
}
]
},
"success": {
"description": "whether the product refresh was successful",
"type": "boolean"
}
},
"required": [
"product",
"success"
]
},
"LinkState": {
"type": "string",
"enum": [
"connecting",
"connected",
"deleted",
"error"
]
},
"ListAccountsResponse": {
"type": "object",
"properties": {
"accounts": {
"description": "A mapping of link id to list of accounts",
"type": "array",
"items": {
"$ref": "#/components/schemas/Account"
}
}
},
"required": [
"accounts"
]
},
"ListInvestmentHoldingsResponse": {
"type": "object",
"properties": {
"holdings": {
"description": "The list of holdings",
"type": "array",
"items": {
"$ref": "#/components/schemas/InvestmentHolding"
}
},
"securities": {
"description": "The list of securities associated with the holdings",
"type": "array",
"items": {
"$ref": "#/components/schemas/Security"
}
}
},
"required": [
"holdings",
"securities"
]
},
"ListInvestmentTransactionsResponse": {
"type": "object",
"properties": {
"investment_transactions": {
"description": "The list of transactions",
"type": "array",
"items": {
"$ref": "#/components/schemas/InvestmentTransaction"
}
},
"page": {
"example": 1,
"description": "The page number of the current page",
"type": "integer",
"format": "int64"
},
"securities": {
"description": "The list of securities associated with the transactions",
"type": "array",
"items": {
"$ref": "#/components/schemas/Security"
}
},
"size": {
"example": 25,
"description": "The number of results per page",
"type": "integer",
"format": "int64"
},
"total": {
"example": 50,
"description": "The total number of transactions",
"type": "integer",
"format": "int64"
}
},
"required": [
"investment_transactions",
"page",
"securities",
"size",
"total"
]
},
"ListLinksResponse": {
"type": "object",
"properties": {
"links": {
"description": "The list of links",
"type": "array",
"items": {
"$ref": "#/components/schemas/Link"
}
}
},
"required": [
"links"
]
},
"ListTransactionsResponse": {
"type": "object",
"properties": {
"page": {
"example": 1,
"description": "The page number of the current page",
"type": "integer",
"format": "int64"
},
"size": {
"example": 25,
"description": "The number of results per page",
"type": "integer",
"format": "int64"
},
"total": {
"example": 100,
"description": "The total number of transactions",
"type": "integer",
"format": "int64"
},
"transactions": {
"description": "The list of transactions",
"type": "array",
"items": {
"$ref": "#/components/schemas/Transaction"
}
}
},
"required": [
"page",
"size",
"total",
"transactions"
]
},
"LiteUser": {
"type": "object",
"properties": {
"external_id": {
"type": "string"
},
"id": {
"example": "fp_id_7p793EF07xKXHqAeg5VGPj",
"type": "string"
},
"sandbox_id": {
"description": "Only populated for users created in sandbox mode.",
"type": "string"
}
},
"required": [
"id"
]
},
"LivenessAttributes": {
"type": "object",
"properties": {
"device": {
"type": "string"
},
"issuers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/LivenessIssuer"
}
},
"metadata": {
"type": "object"
},
"os": {
"type": "string"
}
},
"required": [
"issuers"
]
},
"LivenessEvent": {
"description": "Describes a liveness event that took place",
"type": "object",
"properties": {
"attributes": {
"$ref": "#/components/schemas/LivenessAttributes"
},
"insight_event": {
"$ref": "#/components/schemas/InsightEvent"
},
"source": {
"$ref": "#/components/schemas/LivenessSource"
}
},
"required": [
"source"
]
},
"LivenessIssuer": {
"type": "string",
"enum": [
"apple",
"google",
"cloudflare",
"footprint"
]
},
"LivenessSource": {
"type": "string",
"enum": [
"skipped",
"webauthn_attestation",
"privacy_pass",
"apple_device_attestation",
"google_device_attestation"
]
},
"MatchLevel": {
"type": "string",
"enum": [
"no_match",
"could_not_match",
"partial",
"exact"
]
},
"ModernClientTokenScopeKind": {
"type": "string",
"enum": [
"vault",
"decrypt",
"vault_and_decrypt",
"decrypt_download",
"vault_card"
]
},
"NewBusinessOwnerRequest": {
"type": "object",
"properties": {
"fp_id": {
"type": "string"
},
"ownership_stake": {
"example": 20,
"description": "The percentage of the business that this user owns, between 0 and 100 (inclusive).",
"type": "integer",
"format": "int32"
}
},
"required": [
"fp_id",
"ownership_stake"
]
},
"ObSessionPrefillContext": {
"type": "object",
"properties": {
"client_token": {
"example": "ctok_vJK5Ze2N5fQ1GtE5V770BH8CZtQwXHF1hxowB9Nowh0",
"description": "A short-lived token that gives temporary access to decrypt and vault data for the user using our [client-side vaulting APIs](https://docs.onefootprint.com/api-reference#client-vaulting).\n When populated, you must use this token to decrypt and display prefill data to the end user\n for confirmation.",
"type": "string"
},
"expires_at": {
"type": "string",
"format": "date-time"
}
},
"required": [
"client_token",
"expires_at"
]
},
"Officer": {
"description": "An officer listed on a business registration.",
"type": "object",
"properties": {
"name": {
"description": "Full name of the officer.",
"type": "string"
},
"roles": {
"description": "Roles held by the officer (e.g. director, president).",
"type": "string"
}
}
},
"OffsetPaginatedBusinessOwner": {
"description": "",
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BusinessOwner"
}
},
"meta": {
"type": "object",
"properties": {
"next_page": {
"example": 2,
"description": "The `page` parameter to provide in order to request the next page of results",
"type": "integer",
"format": "int64"
}
}
}
},
"required": [
"data",
"meta"
]
},
"OffsetPaginatedPublicAuthEvent": {
"description": "",
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PublicAuthEvent"
}
},
"meta": {
"type": "object",
"properties": {
"count": {
"example": 10000,
"description": "The total number of results",
"type": "integer",
"format": "int64"
},
"next_page": {
"example": 2,
"description": "The `page` parameter to provide in order to request the next page of results",
"type": "integer",
"format": "int64"
}
},
"required": [
"count"
]
}
},
"required": [
"data",
"meta"
]
},
"OffsetPaginatedPublicOnboarding": {
"description": "",
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PublicOnboarding"
}
},
"meta": {
"type": "object",
"properties": {
"next_page": {
"example": 2,
"description": "The `page` parameter to provide in order to request the next page of results",
"type": "integer",
"format": "int64"
}
}
}
},
"required": [
"data",
"meta"
]
},
"OffsetPaginatedPublicOnboardingDecision": {
"description": "",
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PublicOnboardingDecision"
}
},
"meta": {
"type": "object",
"properties": {
"next_page": {
"example": 2,
"description": "The `page` parameter to provide in order to request the next page of results",
"type": "integer",
"format": "int64"
}
}
}
},
"required": [
"data",
"meta"
]
},
"OnboardingCompletedPayload": {
"example": {
"event_kind": "footprint.onboarding.completed",
"fp_id": "fp_id_xyz",
"timestamp": "2024-06-14T02:40:00Z",
"status": "pass",
"playbook_key": "pb_test_QoEYTOve49Q2IAmaKVYnPs",
"requires_manual_review": false,
"is_live": false,
"onboarding_id": "ob_SRFT2a1mN7DAWJ0VPXkiqK",
"external_id": null,
"onboarding_external_id": null
},
"title": "footprint.onboarding.completed",
"description": "The user has completed onboarding onto a playbook and we have a terminal status.\n\nIn most cases, this will fire as the user finishes the onboarding flow. In some cases (like KYB), the terminal verification status may not come until a few minutes after the user has exited the onboarding flow.\n\nGenerally, you should be able to receive the completed onboarding's status synchronously when the user finishes onboarding via the POST /onboarding/session/validate API. You only need to listen to the status here as a fallback in case a user's status is pending after they finish onboarding. For more information [see here](https://docs.onefootprint.com/articles/guide/definitive-integration-guide#the-end-to-end-integration-step-5-process-the-validation-token).",
"type": "object",
"properties": {
"event_kind": {
"type": "string",
"enum": [
"footprint.onboarding.completed"
]
},
"external_id": {
"type": "string"
},
"fp_id": {
"type": "string"
},
"is_live": {
"type": "boolean"
},
"onboarding_external_id": {
"type": "string"
},
"onboarding_id": {
"type": "string"
},
"playbook_key": {
"type": "string"
},
"requires_manual_review": {
"type": "boolean"
},
"status": {
"$ref": "#/components/schemas/DecisionStatus"
},
"timestamp": {
"type": "string",
"format": "date-time"
}
},
"required": [
"event_kind",
"fp_id",
"is_live",
"onboarding_id",
"requires_manual_review",
"status",
"timestamp"
]
},
"OnboardingDecisionKind": {
"type": "string",
"enum": [
"manual",
"playbook_run"
]
},
"OnboardingRequestPbKey": {
"type": "object",
"properties": {
"key": {
"description": "The playbook key that should be used for the onboarding.",
"type": "string"
}
},
"required": [
"key"
]
},
"OnboardingSessionFixtureResult": {
"type": "string",
"enum": [
"fail",
"pass",
"manual_review",
"evaluate_rules",
"choose_branch_outcomes"
]
},
"OnboardingSessionRunResponse": {
"type": "object",
"properties": {
"continue_onboarding": {
"$ref": "#/components/schemas/ContinueOnboardingContext"
},
"prefill": {
"allOf": [
{
"$ref": "#/components/schemas/ObSessionPrefillContext"
},
{
"x_fp_preview_gate": "third_party_auth",
"type": "object"
}
]
},
"requires_manual_review": {
"type": "boolean"
},
"status": {
"allOf": [
{
"$ref": "#/components/schemas/OnboardingStatus"
},
{
"description": "The decision for this onboarding issued by the Action nodes on your playbook.\n For more information on interpreting statuses, see\n [here](https://docs.onefootprint.com/articles/guide/definitive-integration-guide#the-end-to-end-integration-step-5-process-the-validation-token-the-verification-result).",
"type": "string"
}
]
}
},
"required": [
"requires_manual_review",
"status"
]
},
"OnboardingStatus": {
"type": "string",
"enum": [
"pass",
"fail",
"incomplete",
"pending",
"none",
"error"
]
},
"PiiJsonValue": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer",
"format": "int64"
},
{
"type": "boolean"
},
{
"type": "object"
}
]
},
"PostUsersKycResponse": {
"allOf": [
{
"type": "object",
"properties": {
"in_progress_link": {
"allOf": [
{
"$ref": "#/components/schemas/CreateTokenResponse"
},
{
"description": "If the user triggers a step up rule, a link that can be used to prompt the user to finish\n uploading any remaining information.",
"x_fp_preview_gate": "post_kyc_stepup_links",
"type": "object"
}
]
}
}
},
{
"$ref": "#/components/schemas/EntityValidateResponse"
}
]
},
"Product": {
"type": "string",
"enum": [
"accounts",
"account_numbers",
"transactions",
"investments",
"identity",
"enrichment"
]
},
"ProductError": {
"type": "string",
"enum": [
"unknown",
"rate_limit",
"auth_expired",
"not_supported",
"timeout",
"no_accounts",
"institution_error",
"no_permission",
"other"
]
},
"ProductStatus": {
"type": "object",
"properties": {
"error": {
"allOf": [
{
"$ref": "#/components/schemas/ProductError"
},
{
"example": null,
"type": "string"
}
]
},
"error_message": {
"example": null,
"type": "string"
},
"last_attempted_at": {
"example": "2023-05-15T14:30:00Z",
"type": "string",
"format": "date-time"
},
"refreshed_at": {
"example": "2023-05-15T14:30:00Z",
"type": "string",
"format": "date-time"
},
"unavailable": {
"example": null,
"type": "string"
}
}
},
"ProductStatuses": {
"type": "object",
"properties": {
"account_numbers": {
"$ref": "#/components/schemas/ProductStatus"
},
"accounts": {
"$ref": "#/components/schemas/ProductStatus"
},
"enrichment": {
"allOf": [
{
"$ref": "#/components/schemas/ProductStatus"
},
{
"example": null,
"type": "object"
}
]
},
"identity": {
"allOf": [
{
"$ref": "#/components/schemas/ProductStatus"
},
{
"example": null,
"type": "object"
}
]
},
"investments": {
"allOf": [
{
"$ref": "#/components/schemas/ProductStatus"
},
{
"example": null,
"type": "object"
}
]
},
"transactions": {
"$ref": "#/components/schemas/ProductStatus"
}
}
},
"Provider": {
"type": "string",
"enum": [
"plaid"
]
},
"PublicAuthEvent": {
"type": "object",
"properties": {
"created_at": {
"type": "string",
"format": "date-time"
},
"insight": {
"allOf": [
{
"$ref": "#/components/schemas/PublicInsightEvent"
},
{
"description": "Information on from where the auth occurred",
"type": "object"
}
]
},
"kind": {
"$ref": "#/components/schemas/AuthEventKind"
}
},
"required": [
"created_at",
"kind"
]
},
"PublicDocument": {
"type": "object",
"properties": {
"created_at": {
"type": "string",
"format": "date-time"
},
"document_type": {
"allOf": [
{
"$ref": "#/components/schemas/DocumentKind"
},
{
"description": "Document type of the successfully uploaded document. Can be used to fetch from vault",
"type": "string"
}
]
},
"id": {
"description": "Identifier for a document",
"type": "string"
},
"images": {
"allOf": [
{
"$ref": "#/components/schemas/DocumentImages"
},
{
"description": "Information about the uploaded images that can be used to fetch from the vault. For example,\n use the decrypt endpoint with `:` to fetch a particular document image",
"type": "object"
}
]
},
"onboarding_id": {
"description": "The identifier of the onboarding in which this Document was collected",
"type": "string"
}
},
"required": [
"created_at",
"document_type",
"id",
"images",
"onboarding_id"
]
},
"PublicDuplicateFingerprint": {
"type": "object",
"properties": {
"external_id": {
"description": "The tenant-supplied identifier associated with the duplicate",
"type": "string"
},
"fp_id": {
"description": "The Footprint identifier for the duplicate",
"type": "string"
},
"kind": {
"allOf": [
{
"$ref": "#/components/schemas/DupeKind"
},
{
"description": "The kind of duplicate connection",
"type": "string"
}
]
},
"label": {
"allOf": [
{
"$ref": "#/components/schemas/LabelKind"
},
{
"description": "The label of the duplicate",
"type": "string"
}
]
},
"tags": {
"description": "The tags associated with the duplicate",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"fp_id",
"kind",
"tags"
]
},
"PublicEntityStatusValue": {
"type": "object",
"properties": {
"kind": {
"description": "The slug of the status.",
"type": "string"
},
"updated_at": {
"type": "string",
"format": "date-time"
},
"value": {
"description": "The value of the `kind` of status.",
"type": "string"
}
},
"required": [
"kind",
"updated_at"
]
},
"PublicIdentityDocumentConsent": {
"type": "object",
"properties": {
"consent_text": {
"description": "The text of the consent",
"type": "string"
},
"service_improvement_consent_accepted": {
"description": "Whether the optional service improvement consent was accepted",
"type": "boolean"
},
"timestamp_accepted": {
"description": "The timestamp the service (and optional service improvement) consent was accepted",
"type": "string",
"format": "date-time"
}
},
"required": [
"consent_text",
"service_improvement_consent_accepted",
"timestamp_accepted"
]
},
"PublicInsightEvent": {
"type": "object",
"properties": {
"city": {
"example": "San Francisco",
"type": "string"
},
"country": {
"example": "United States",
"type": "string"
},
"ip_address": {
"type": "string"
},
"latitude": {
"example": 37.7703,
"type": "number",
"format": "double"
},
"longitude": {
"example": -122.4407,
"type": "number",
"format": "double"
},
"postal_code": {
"example": 94117,
"type": "string"
},
"region": {
"example": "CA",
"type": "string"
},
"timestamp": {
"type": "string",
"format": "date-time"
},
"user_agent": {
"example": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/17.0 Safari/605.1.15",
"type": "string"
}
},
"required": [
"timestamp"
]
},
"PublicOnboarding": {
"type": "object",
"properties": {
"external_id": {
"description": "The `onboarding_external_id` provided when the onboarding session token was created",
"type": "string"
},
"id": {
"example": "ob_SRFT2a1mN7DAWJ0VPXkiqK",
"description": "A unique identitifer for the onboarding",
"type": "string"
},
"playbook_key": {
"example": "pb_live_fZvYlX3JpanlQ3MAwE45g0",
"type": "string"
},
"status": {
"allOf": [
{
"$ref": "#/components/schemas/OnboardingStatus"
},
{
"description": "The status of the onboarding",
"type": "string"
}
]
},
"timestamp": {
"description": "The timestamp of onboarding creation",
"type": "string",
"format": "date-time"
}
},
"required": [
"id",
"playbook_key",
"status",
"timestamp"
]
},
"PublicOnboardingDecision": {
"type": "object",
"properties": {
"annotation": {
"description": "The annotation left by a human as part of this decision. Only populated for some decisions\n with kind `manual`.",
"type": "string"
},
"kind": {
"$ref": "#/components/schemas/OnboardingDecisionKind"
},
"playbook_key": {
"type": "string"
},
"reviewer_email": {
"description": "The email of the reviewer who made this decision. Only populated for some decisions with\n kind `manual`.",
"type": "string"
},
"status": {
"$ref": "#/components/schemas/DecisionStatus"
},
"timestamp": {
"type": "string",
"format": "date-time"
}
},
"required": [
"kind",
"status",
"timestamp"
]
},
"PublicRiskSignal": {
"type": "object",
"properties": {
"description": {
"example": "Address located does not match address input.",
"type": "string"
},
"note": {
"example": "Address does not match",
"type": "string"
},
"reason_code": {
"allOf": [
{
"$ref": "#/components/schemas/FootprintReasonCode"
},
{
"example": "address_does_not_match",
"type": "string"
}
]
},
"scopes": {
"example": [
"address"
],
"type": "array",
"items": {
"$ref": "#/components/schemas/SignalScope"
}
},
"severity": {
"allOf": [
{
"$ref": "#/components/schemas/SignalSeverity"
},
{
"example": "high",
"type": "string"
}
]
},
"timestamp": {
"type": "string",
"format": "date-time"
}
},
"required": [
"description",
"note",
"reason_code",
"scopes",
"severity",
"timestamp"
]
},
"PublicRiskSignalDescription": {
"type": "object",
"properties": {
"description": {
"description": "Description of the reason code",
"type": "string"
},
"note": {
"description": "Short description of the reason code",
"type": "string"
},
"reason_code": {
"$ref": "#/components/schemas/FootprintReasonCode"
},
"scopes": {
"description": "What the reason code applies to (Name, Document, Business, etc)",
"type": "array",
"items": {
"$ref": "#/components/schemas/SignalScope"
}
},
"severity": {
"allOf": [
{
"$ref": "#/components/schemas/SignalSeverity"
},
{
"description": "An indication of importance",
"type": "string"
}
]
}
},
"required": [
"description",
"note",
"reason_code",
"scopes",
"severity"
]
},
"PublicUserConsentKind": {
"type": "string",
"enum": [
"verified_prefill",
"terms_and_conditions"
]
},
"PublicWorkflowRequest": {
"type": "object",
"properties": {
"note": {
"description": "The human-readable note you provided in the dashboard when requesting additional info. You\n may choose to render this message in your own application.",
"type": "string"
},
"timestamp": {
"description": "The timestamp at which the additional info was requested.",
"type": "string",
"format": "date-time"
}
},
"required": [
"timestamp"
]
},
"RawBusinessDataRequest": {
"example": {
"business.name": "Acme Bank",
"business.website": "acmebank.org",
"custom.account_id": "d0af81fc-41c2-46ca-8a8d-797b8e4d3146"
},
"description": "Key-value map of data to add to the business's vault. For more documentation on available keys, see [here](https://docs.onefootprint.com/articles/vault/fields).",
"type": "object",
"properties": {
"": {
"type": "string",
"enum": [
"business.name",
"business.dba",
"business.website",
"business.phone_number",
"business.tin",
"business.address_line1",
"business.address_line2",
"business.city",
"business.state",
"business.zip",
"business.country",
"business.beneficial_owners.*.ownership_stake",
"business.beneficial_owners.*.id.first_name",
"business.beneficial_owners.*.id.last_name",
"business.beneficial_owners.*.id.phone_number",
"business.beneficial_owners.*.id.email",
"business.beneficial_owner_explanation_message",
"business.corporation_type",
"business.formation_state",
"business.formation_date",
"custom.*"
]
},
"": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer",
"format": "int64"
},
{
"type": "boolean"
},
{
"type": "object"
}
]
}
},
"required": [
"",
""
]
},
"RawUserDataRequest": {
"example": {
"id.first_name": "Jane",
"id.last_name": "Doe",
"custom.user_id": "7c50e2bc-c31f-42e3-b2b0-9852010cfd58"
},
"description": "Key-value map of data to add to the user's vault. For more documentation on available keys, see [here](https://docs.onefootprint.com/articles/vault/fields).",
"type": "object",
"properties": {
"": {
"type": "string",
"enum": [
"id.first_name",
"id.middle_name",
"id.last_name",
"id.dob",
"id.ssn4",
"id.ssn9",
"id.address_line1",
"id.address_line2",
"id.city",
"id.state",
"id.zip",
"id.country",
"id.email",
"id.phone_number",
"id.us_legal_status",
"id.visa_kind",
"id.visa_expiration_date",
"id.nationality",
"id.citizenships",
"id.drivers_license_number",
"id.drivers_license_state",
"id.itin",
"id.us_tax_id",
"custom.*",
"investor_profile.employment_status",
"investor_profile.occupation",
"investor_profile.employer",
"investor_profile.annual_income",
"investor_profile.net_worth",
"investor_profile.investment_goals",
"investor_profile.risk_tolerance",
"investor_profile.declarations",
"investor_profile.brokerage_firm_employer",
"investor_profile.senior_executive_symbols",
"investor_profile.family_member_names",
"investor_profile.political_organization",
"investor_profile.funding_sources",
"document.id_card.front.image",
"document.id_card.front.latest_upload",
"document.id_card.front.mime_type",
"document.id_card.back.image",
"document.id_card.back.latest_upload",
"document.id_card.back.mime_type",
"document.id_card.selfie.image",
"document.id_card.selfie.latest_upload",
"document.id_card.selfie.mime_type",
"document.id_card.full_name",
"document.id_card.first_name",
"document.id_card.last_name",
"document.id_card.dob",
"document.id_card.gender",
"document.id_card.full_address",
"document.id_card.address_line1",
"document.id_card.city",
"document.id_card.state",
"document.id_card.country",
"document.id_card.postal_code",
"document.id_card.document_number",
"document.id_card.expires_at",
"document.id_card.issued_at",
"document.id_card.issuing_state",
"document.id_card.issuing_country",
"document.id_card.ref_number",
"document.id_card.nationality",
"document.id_card.curp",
"document.id_card.clave_de_elector",
"document.id_card.classified_document_type",
"document.id_card.curp_validation_response",
"document.id_card.samba_activity_history_response",
"document.id_card.us_issuing_state",
"document.drivers_license.front.image",
"document.drivers_license.front.latest_upload",
"document.drivers_license.front.mime_type",
"document.drivers_license.back.image",
"document.drivers_license.back.latest_upload",
"document.drivers_license.back.mime_type",
"document.drivers_license.selfie.image",
"document.drivers_license.selfie.latest_upload",
"document.drivers_license.selfie.mime_type",
"document.drivers_license.full_name",
"document.drivers_license.first_name",
"document.drivers_license.last_name",
"document.drivers_license.dob",
"document.drivers_license.gender",
"document.drivers_license.full_address",
"document.drivers_license.address_line1",
"document.drivers_license.city",
"document.drivers_license.state",
"document.drivers_license.country",
"document.drivers_license.postal_code",
"document.drivers_license.document_number",
"document.drivers_license.expires_at",
"document.drivers_license.issued_at",
"document.drivers_license.issuing_state",
"document.drivers_license.issuing_country",
"document.drivers_license.ref_number",
"document.drivers_license.nationality",
"document.drivers_license.curp",
"document.drivers_license.clave_de_elector",
"document.drivers_license.classified_document_type",
"document.drivers_license.curp_validation_response",
"document.drivers_license.samba_activity_history_response",
"document.drivers_license.us_issuing_state",
"document.passport.front.image",
"document.passport.front.latest_upload",
"document.passport.front.mime_type",
"document.passport.back.image",
"document.passport.back.latest_upload",
"document.passport.back.mime_type",
"document.passport.selfie.image",
"document.passport.selfie.latest_upload",
"document.passport.selfie.mime_type",
"document.passport.full_name",
"document.passport.first_name",
"document.passport.last_name",
"document.passport.dob",
"document.passport.gender",
"document.passport.full_address",
"document.passport.address_line1",
"document.passport.city",
"document.passport.state",
"document.passport.country",
"document.passport.postal_code",
"document.passport.document_number",
"document.passport.expires_at",
"document.passport.issued_at",
"document.passport.issuing_state",
"document.passport.issuing_country",
"document.passport.ref_number",
"document.passport.nationality",
"document.passport.curp",
"document.passport.clave_de_elector",
"document.passport.classified_document_type",
"document.passport.curp_validation_response",
"document.passport.samba_activity_history_response",
"document.passport.us_issuing_state",
"document.passport_card.front.image",
"document.passport_card.front.latest_upload",
"document.passport_card.front.mime_type",
"document.passport_card.back.image",
"document.passport_card.back.latest_upload",
"document.passport_card.back.mime_type",
"document.passport_card.selfie.image",
"document.passport_card.selfie.latest_upload",
"document.passport_card.selfie.mime_type",
"document.passport_card.full_name",
"document.passport_card.first_name",
"document.passport_card.last_name",
"document.passport_card.dob",
"document.passport_card.gender",
"document.passport_card.full_address",
"document.passport_card.address_line1",
"document.passport_card.city",
"document.passport_card.state",
"document.passport_card.country",
"document.passport_card.postal_code",
"document.passport_card.document_number",
"document.passport_card.expires_at",
"document.passport_card.issued_at",
"document.passport_card.issuing_state",
"document.passport_card.issuing_country",
"document.passport_card.ref_number",
"document.passport_card.nationality",
"document.passport_card.curp",
"document.passport_card.clave_de_elector",
"document.passport_card.classified_document_type",
"document.passport_card.curp_validation_response",
"document.passport_card.samba_activity_history_response",
"document.passport_card.us_issuing_state",
"document.permit.front.image",
"document.permit.front.latest_upload",
"document.permit.front.mime_type",
"document.permit.back.image",
"document.permit.back.latest_upload",
"document.permit.back.mime_type",
"document.permit.selfie.image",
"document.permit.selfie.latest_upload",
"document.permit.selfie.mime_type",
"document.permit.full_name",
"document.permit.first_name",
"document.permit.last_name",
"document.permit.dob",
"document.permit.gender",
"document.permit.full_address",
"document.permit.address_line1",
"document.permit.city",
"document.permit.state",
"document.permit.country",
"document.permit.postal_code",
"document.permit.document_number",
"document.permit.expires_at",
"document.permit.issued_at",
"document.permit.issuing_state",
"document.permit.issuing_country",
"document.permit.ref_number",
"document.permit.nationality",
"document.permit.curp",
"document.permit.clave_de_elector",
"document.permit.classified_document_type",
"document.permit.curp_validation_response",
"document.permit.samba_activity_history_response",
"document.permit.us_issuing_state",
"document.visa.front.image",
"document.visa.front.latest_upload",
"document.visa.front.mime_type",
"document.visa.back.image",
"document.visa.back.latest_upload",
"document.visa.back.mime_type",
"document.visa.selfie.image",
"document.visa.selfie.latest_upload",
"document.visa.selfie.mime_type",
"document.visa.full_name",
"document.visa.first_name",
"document.visa.last_name",
"document.visa.dob",
"document.visa.gender",
"document.visa.full_address",
"document.visa.address_line1",
"document.visa.city",
"document.visa.state",
"document.visa.country",
"document.visa.postal_code",
"document.visa.document_number",
"document.visa.expires_at",
"document.visa.issued_at",
"document.visa.issuing_state",
"document.visa.issuing_country",
"document.visa.ref_number",
"document.visa.nationality",
"document.visa.curp",
"document.visa.clave_de_elector",
"document.visa.classified_document_type",
"document.visa.curp_validation_response",
"document.visa.samba_activity_history_response",
"document.visa.us_issuing_state",
"document.residence_document.front.image",
"document.residence_document.front.latest_upload",
"document.residence_document.front.mime_type",
"document.residence_document.back.image",
"document.residence_document.back.latest_upload",
"document.residence_document.back.mime_type",
"document.residence_document.selfie.image",
"document.residence_document.selfie.latest_upload",
"document.residence_document.selfie.mime_type",
"document.residence_document.full_name",
"document.residence_document.first_name",
"document.residence_document.last_name",
"document.residence_document.dob",
"document.residence_document.gender",
"document.residence_document.full_address",
"document.residence_document.address_line1",
"document.residence_document.city",
"document.residence_document.state",
"document.residence_document.country",
"document.residence_document.postal_code",
"document.residence_document.document_number",
"document.residence_document.expires_at",
"document.residence_document.issued_at",
"document.residence_document.issuing_state",
"document.residence_document.issuing_country",
"document.residence_document.ref_number",
"document.residence_document.nationality",
"document.residence_document.curp",
"document.residence_document.clave_de_elector",
"document.residence_document.classified_document_type",
"document.residence_document.curp_validation_response",
"document.residence_document.samba_activity_history_response",
"document.residence_document.us_issuing_state",
"document.voter_identification.front.image",
"document.voter_identification.front.latest_upload",
"document.voter_identification.front.mime_type",
"document.voter_identification.back.image",
"document.voter_identification.back.latest_upload",
"document.voter_identification.back.mime_type",
"document.voter_identification.selfie.image",
"document.voter_identification.selfie.latest_upload",
"document.voter_identification.selfie.mime_type",
"document.voter_identification.full_name",
"document.voter_identification.first_name",
"document.voter_identification.last_name",
"document.voter_identification.dob",
"document.voter_identification.gender",
"document.voter_identification.full_address",
"document.voter_identification.address_line1",
"document.voter_identification.city",
"document.voter_identification.state",
"document.voter_identification.country",
"document.voter_identification.postal_code",
"document.voter_identification.document_number",
"document.voter_identification.expires_at",
"document.voter_identification.issued_at",
"document.voter_identification.issuing_state",
"document.voter_identification.issuing_country",
"document.voter_identification.ref_number",
"document.voter_identification.nationality",
"document.voter_identification.curp",
"document.voter_identification.clave_de_elector",
"document.voter_identification.classified_document_type",
"document.voter_identification.curp_validation_response",
"document.voter_identification.samba_activity_history_response",
"document.voter_identification.us_issuing_state",
"document.finra_compliance_letter",
"document.proof_of_address.image",
"document.ssn_card.image",
"document.custom.*",
"card.*.number",
"card.*.expiration",
"card.*.cvc",
"card.*.name",
"card.*.billing_address.zip",
"card.*.billing_address.country",
"card.*.expiration_month",
"card.*.expiration_year",
"card.*.number_last4",
"card.*.issuer",
"card.*.fingerprint",
"bank.*.name",
"bank.*.ach_routing_number",
"bank.*.ach_wire_routing_number",
"bank.*.ach_account_number",
"bank.*.ach_account_id",
"bank.*.account_type",
"bank.*.institution_id",
"bank.*.institution_name",
"bank.*.account_last4",
"bank.*.iban",
"bank.*.bic",
"bank.*.owners",
"bank.*.mk_link_id",
"bank.*.link_id",
"bank.*.closed",
"bank.*.fingerprint"
]
},
"": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer",
"format": "int64"
},
{
"type": "boolean"
},
{
"type": "object"
}
]
}
},
"required": [
"",
""
]
},
"RedactRequest": {
"type": "object",
"properties": {
"retain_fields": {
"description": "Optional list of `id.*` fields to retain (not redact). Only identity data fields (id.*) are\n allowed. If null or not provided, all fields will be redacted.",
"type": "array",
"items": {
"$ref": "#/components/schemas/DataIdentifier"
}
}
}
},
"RefreshProductsRequest": {
"type": "object",
"properties": {
"products": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Product"
}
}
},
"required": [
"products"
]
},
"ScopedVaultStatus": {
"type": "string",
"enum": [
"pass",
"fail",
"incomplete",
"pending",
"none"
]
},
"SearchUsersRequestBody": {
"type": "object",
"properties": {
"external_id": {
"description": "Return only the user with this `external_id`.",
"type": "string"
},
"pagination": {
"type": "object",
"properties": {
"cursor": {
"example": null,
"type": "integer"
},
"page_size": {
"example": 10,
"type": "integer",
"format": "int64"
}
}
},
"search": {
"example": "sandbox@onefootprint.com",
"description": "PII search query. Returns users that have matching PII.",
"type": "string"
}
}
},
"Security": {
"type": "object",
"properties": {
"close_date": {
"example": "2023-05-15",
"description": "The security's close price date",
"type": "string"
},
"close_price": {
"example": 150.75,
"description": "The security's close price",
"type": "string"
},
"currency": {
"example": "USD",
"description": "The security currency (ISO-4217)",
"type": "string"
},
"isin": {
"example": "US0378331005",
"description": "The security's ISIN (International Securities Identification Number, ISO 6166)",
"type": "string"
},
"name": {
"example": "Apple Inc.",
"description": "The security name",
"type": "string"
},
"security_id": {
"example": "sec_aapl",
"description": "The security ID",
"type": "string"
},
"sedol": {
"example": 2046251,
"description": "The security's sedol id (London Stock Exchange)",
"type": "string"
},
"ticker": {
"example": "AAPL",
"description": "The security ticker",
"type": "string"
},
"type": {
"example": "equity",
"description": "The security symbol",
"type": "string"
}
},
"required": [
"currency",
"name",
"security_id",
"type"
]
},
"SignalScope": {
"description": "Represents the granularity of data attributes that could be alerted on by a data vendor\n NOTE: this is not the same as \"data attributes we can collect from a user\". Please see\n `DataAttribute` for that",
"type": "string",
"enum": [
"name",
"dob",
"ssn",
"itin",
"address",
"street_address",
"city",
"state",
"zip",
"country",
"email",
"phone_number",
"drivers_license_number",
"ip_address",
"device",
"native_device",
"document",
"selfie",
"behavior",
"business_address",
"business_name",
"business_phone_number",
"business_website",
"business_tin",
"beneficial_owners",
"business_dba"
]
},
"SignalSeverity": {
"type": "string",
"enum": [
"info",
"low",
"medium",
"high"
]
},
"SimpleFixtureResult": {
"type": "string",
"enum": [
"fail",
"pass",
"manual_review"
]
},
"TerminalDecisionStatus": {
"type": "string",
"enum": [
"fail",
"pass"
]
},
"TestWebhookRequest": {
"type": "object",
"properties": {
"idempotency_key": {
"example": "xyz1234...abcd",
"description": "If you want to test idempotency, you can provide an idempotency key here",
"type": "string"
},
"payload": {
"$ref": "#/components/schemas/WebhookEvent"
}
},
"required": [
"payload"
]
},
"ThirdPartyAuthInfo": {
"type": "object",
"properties": {
"kind": {
"$ref": "#/components/schemas/ThirdPartyOtpKind"
},
"timestamp": {
"description": "The time at which the OTP challenge occurred. In ISO8601 format, eg `2022-01-04T12:00:00Z`.",
"type": "string",
"format": "date-time"
}
},
"required": [
"kind",
"timestamp"
]
},
"ThirdPartyOtpKind": {
"type": "string",
"enum": [
"sms"
]
},
"Transaction": {
"type": "object",
"properties": {
"account_id": {
"example": "acc_12345678",
"description": "The account ID",
"type": "string"
},
"amount": {
"example": "42.99",
"description": "The transaction amount",
"type": "string"
},
"category": {
"example": "food_and_drink",
"description": "The transaction category (deprecated)\n Use enrichment instead",
"type": "string"
},
"currency": {
"example": "USD",
"description": "The ISO-4217 currency code of the transaction",
"type": "string"
},
"date": {
"example": "2023-02-16",
"description": "The date of the transaction, in ISO-8601 format",
"type": "string",
"format": "date"
},
"datetime": {
"example": "2023-05-15T14:30:00Z",
"description": "If the institution has provided the actual time of the transaction, this field contains the\n full date and time of the transaction, in ISO-8601 format. If the time is not available,\n this field will be null.Note that the time is generally reported in the timezone of the\n institution or the account holder.",
"type": "string"
},
"description": {
"example": "Starbucks Coffee",
"description": "The transaction description (cleaned and normalized)",
"type": "string"
},
"enrichment": {
"allOf": [
{
"$ref": "#/components/schemas/TransactionEnrichment"
},
{
"description": "The transaction enrichment",
"type": "object"
}
]
},
"pending": {
"example": false,
"description": "Whether the transaction is pending",
"type": "boolean"
},
"raw_description": {
"example": "POS PURCHASE STARBUCKS STORE",
"description": "The raw description from the institution",
"type": "string"
},
"transaction_id": {
"example": "txn_abcdefgh1234",
"description": "The transaction ID",
"type": "string"
},
"type": {
"allOf": [
{
"$ref": "#/components/schemas/TransactionType"
},
{
"description": "The type of transaction",
"type": "string"
}
]
}
},
"required": [
"account_id",
"amount",
"currency",
"date",
"pending",
"transaction_id",
"type"
]
},
"TransactionEnrichment": {
"type": "object",
"properties": {
"category": {
"$ref": "#/components/schemas/TransactionEnrichmentCategoryValue"
},
"merchant": {
"$ref": "#/components/schemas/TransactionEnrichmentEntityValue"
},
"processor": {
"$ref": "#/components/schemas/TransactionEnrichmentEntityValue"
},
"subcategory": {
"$ref": "#/components/schemas/TransactionEnrichmentSubcategoryValue"
}
}
},
"TransactionEnrichmentCategoryValue": {
"type": "object",
"properties": {
"confidence": {
"example": "95",
"description": "The confidence score of the category, as a percentage from 1-99",
"type": "integer",
"format": "int32"
},
"value": {
"$ref": "#/components/schemas/BankTransactionCategory"
}
},
"required": [
"value"
]
},
"TransactionEnrichmentEntityValue": {
"type": "object",
"properties": {
"confidence": {
"example": 95,
"description": "The confidence score of the entity, as a percentage from 1-99",
"type": "integer",
"format": "int32"
},
"id": {
"example": "starbucks",
"description": "The id of the entity",
"type": "string"
},
"logo": {
"example": "https://example.com/starbucks.png",
"description": "The logo of the entity",
"type": "string"
},
"name": {
"example": "Starbucks",
"description": "The name of the entity",
"type": "string"
}
}
},
"TransactionEnrichmentSubcategoryValue": {
"type": "object",
"properties": {
"confidence": {
"example": "95",
"description": "The confidence score of the sub-category, as a percentage from 1-99",
"type": "integer",
"format": "int32"
},
"value": {
"$ref": "#/components/schemas/BankTransactionSubcategory"
}
},
"required": [
"value"
]
},
"TransactionType": {
"type": "string",
"enum": [
"debit",
"credit"
]
},
"TransactionsSyncCursor": {
"type": "object",
"properties": {
"next": {
"example": "abcdefgh1234",
"description": "The cursor value to use in the next request",
"type": "string"
}
}
},
"TransactionsSyncResponse": {
"type": "object",
"properties": {
"cursor": {
"allOf": [
{
"$ref": "#/components/schemas/TransactionsSyncCursor"
},
{
"description": "The cursor value to use in the next request",
"type": "object"
}
]
},
"has_more": {
"example": true,
"description": "The number of results per page",
"type": "boolean"
},
"transactions": {
"allOf": [
{
"$ref": "#/components/schemas/TransactionsSynced"
},
{
"description": "The list of transactions tagged with created, updated, and removed",
"type": "object"
}
]
}
},
"required": [
"cursor",
"has_more",
"transactions"
]
},
"TransactionsSynced": {
"type": "object",
"properties": {
"created": {
"description": "transactions added to the link",
"type": "array",
"items": {
"$ref": "#/components/schemas/Transaction"
}
},
"removed": {
"description": "transaction removed from the link by the transaction id",
"type": "array",
"items": {
"type": "string"
}
},
"updated": {
"description": "transactions updated on the link",
"type": "array",
"items": {
"$ref": "#/components/schemas/Transaction"
}
}
},
"required": [
"created",
"removed",
"updated"
]
},
"TriggerKybRequest": {
"type": "object",
"properties": {
"allow_reonboard": {
"description": "Run the businesss through KYB on the provided playbook even if they have already onboarded\n onto this playbook. Defaults to true.",
"type": "boolean"
},
"fixture_result": {
"allOf": [
{
"$ref": "#/components/schemas/SimpleFixtureResult"
},
{
"example": null,
"description": "(only valid for sandbox businesses) choose the desired KYB outcome",
"type": "string"
}
]
},
"key": {
"description": "The publishable key of the playbook onto which you would like this business to onboard.\n The playbook will specify required information and the rules by which to make a KYB\n decision.",
"type": "string"
}
},
"required": [
"key"
]
},
"TriggerKycRequest": {
"type": "object",
"properties": {
"allow_reonboard": {
"example": null,
"description": "Run the user through KYC on the provided playbook even if they have already onboarded onto\n this playbook. Defaults to true. Cannot be provided alongside `onboarding_external_id`.",
"type": "boolean"
},
"fixture_result": {
"allOf": [
{
"$ref": "#/components/schemas/SimpleFixtureResult"
},
{
"example": null,
"description": "(only valid for sandbox users) choose the desired KYC outcome.",
"type": "string"
}
]
},
"generate_link_on_stepup": {
"description": "When true, if the user ends up triggering a stepup rule, sends them a link to finish the\n flow.",
"x_fp_preview_gate": "post_kyc_stepup_links",
"type": "boolean"
},
"identity_document_data": {
"allOf": [
{
"$ref": "#/components/schemas/IdentityDocumentData"
},
{
"description": "Document data to use in the playbook verification request\n Only valid on a playbook that collects an identity document",
"x_fp_preview_gate": "headless_document_data",
"type": "object"
}
]
},
"key": {
"description": "The publishable key of the playbook onto which you would like this user to onboard. The\n playbook will specify required information and the rules by which to make a KYC decision.",
"type": "string"
},
"onboarding_external_id": {
"example": null,
"description": "If the user already has an onboarding with this `onboarding_external_id`, its results will\n be reused and returned without allowing the user to edit their data and reonboard. If not, a\n new onboarding will be created and the user will be allowed to onboard as normal.\n Cannot be provided alongside `allow_reonboard`.",
"type": "string"
}
},
"required": [
"key"
]
},
"TrustedContact": {
"description": "This model input is optional. However, the client should make reasonable effort to obtain the\n trusted contact information. See more details in FINRA Notice 17-11",
"type": "object",
"properties": {
"city": {
"type": "string"
},
"country": {
"type": "string"
},
"email_address": {
"description": "In addition, only one of the following is required:",
"type": "string"
},
"family_name": {
"type": "string"
},
"given_name": {
"type": "string"
},
"phone_number": {
"type": "string"
},
"postal_code": {
"type": "string"
},
"state": {
"type": "string"
},
"street_address": {
"type": "string"
}
},
"required": [
"family_name",
"given_name"
]
},
"UpdateEntityRequest": {
"type": "object",
"properties": {
"external_id": {
"description": "Optionally, the new external ID for the entity. Can only be composed of alphanumeric\n characters, underscores, hyphens, and periods. If an entity with this external ID\n already exists, returns a 400.",
"type": "string"
}
}
},
"UpdateLabelRequest": {
"type": "object",
"properties": {
"kind": {
"$ref": "#/components/schemas/LabelKind"
}
}
},
"UpdateUserStatusRequest": {
"type": "object",
"properties": {
"kind": {
"example": "kyc_status",
"description": "The slug of the status to update.",
"type": "string"
},
"value": {
"example": "verified",
"description": "The value to set for the provided status `kind`. A value of `null` will un-set the status",
"type": "string"
}
},
"required": [
"kind"
]
},
"User": {
"description": "Basic information about a user",
"type": "object",
"properties": {
"external_id": {
"type": "string"
},
"id": {
"example": "fp_id_7p793EF07xKXHqAeg5VGPj",
"type": "string"
},
"requires_additional_info": {
"allOf": [
{
"$ref": "#/components/schemas/PublicWorkflowRequest"
},
{
"description": "When non-null, there is additional info pending collection from this user. In this case, you\n may create a token for this user with the `inherit` operation. This token can be used to\n collect any outstanding information.",
"type": "object"
}
]
},
"requires_manual_review": {
"type": "boolean"
},
"status": {
"$ref": "#/components/schemas/ScopedVaultStatus"
},
"statuses": {
"description": "Statuses set for this user",
"type": "array",
"items": {
"$ref": "#/components/schemas/PublicEntityStatusValue"
}
}
},
"required": [
"id",
"requires_manual_review",
"status"
]
},
"UserAuthResponse": {
"type": "object",
"properties": {
"auth_events": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ValidateAuthEvent"
}
},
"external_id": {
"example": null,
"description": "The `external_id` provided for this user, if any.",
"type": "string"
},
"fp_id": {
"type": "string"
}
},
"required": [
"auth_events",
"fp_id"
]
},
"UserBankLinkUpdatedPayload": {
"example": {
"event_kind": "footprint.user.bank_link_updated",
"fp_id": "fp_id_xyz",
"user_external_id": null,
"timestamp": "2024-06-14T02:40:00Z",
"is_live": false,
"link_id": "bank_link_abcd1234",
"link_external_id": null,
"link_state": "connected",
"link_error": null,
"link_event_kind": "link_product_refreshed",
"link_product_refresh": {
"product": "transactions",
"success": true
},
"error_message": null
},
"title": "footprint.user.bank_link_updated",
"description": "A Footprint user's bank link was updated.",
"type": "object",
"properties": {
"error_message": {
"description": "An error message if the update failed",
"type": "string"
},
"event_kind": {
"type": "string",
"enum": [
"footprint.user.bank_link_updated"
]
},
"fp_id": {
"description": "The id of the user the link belongs to",
"type": "string"
},
"is_live": {
"description": "Whether the link was created in live mode",
"type": "boolean"
},
"link_error": {
"allOf": [
{
"$ref": "#/components/schemas/BankLinkError"
},
{
"description": "The current error state of the link",
"type": "object"
}
]
},
"link_event_kind": {
"allOf": [
{
"$ref": "#/components/schemas/BankLinkUpdateKind"
},
{
"description": "The kind of link event update performed",
"type": "string"
}
]
},
"link_external_id": {
"description": "The external id of the bank link",
"type": "string"
},
"link_id": {
"description": "The id of the bank link",
"type": "string"
},
"link_product_refresh": {
"allOf": [
{
"$ref": "#/components/schemas/LinkProductRefresh"
},
{
"description": "If a product was refreshed, this will be populated",
"type": "object"
}
]
},
"link_state": {
"allOf": [
{
"$ref": "#/components/schemas/BankLinkState"
},
{
"description": "The current state of the link",
"type": "object"
}
]
},
"timestamp": {
"description": "The timestamp of the event",
"type": "string",
"format": "date-time"
},
"user_external_id": {
"description": "The external id of the user the link belongs to",
"type": "string"
}
},
"required": [
"event_kind",
"fp_id",
"is_live",
"link_event_kind",
"link_id",
"timestamp"
]
},
"UserConsentContext": {
"type": "object",
"properties": {
"content": {
"description": "The textual content of the consent accepted by the user.",
"type": "string"
},
"kind": {
"allOf": [
{
"$ref": "#/components/schemas/PublicUserConsentKind"
},
{
"description": "The kind of consent that was displayed to the user.",
"type": "string"
}
]
},
"timestamp": {
"description": "The time at which the consent was accepted by the user. In ISO8601 format, eg\n `2022-01-04T12:00:00Z`.",
"type": "string",
"format": "date-time"
}
},
"required": [
"content",
"kind",
"timestamp"
]
},
"UserDataIdentifier": {
"type": "string",
"enum": [
"id.first_name",
"id.middle_name",
"id.last_name",
"id.dob",
"id.ssn4",
"id.ssn9",
"id.address_line1",
"id.address_line2",
"id.city",
"id.state",
"id.zip",
"id.country",
"id.email",
"id.phone_number",
"id.us_legal_status",
"id.visa_kind",
"id.visa_expiration_date",
"id.nationality",
"id.citizenships",
"id.drivers_license_number",
"id.drivers_license_state",
"id.itin",
"id.us_tax_id",
"custom.*",
"investor_profile.employment_status",
"investor_profile.occupation",
"investor_profile.employer",
"investor_profile.annual_income",
"investor_profile.net_worth",
"investor_profile.investment_goals",
"investor_profile.risk_tolerance",
"investor_profile.declarations",
"investor_profile.brokerage_firm_employer",
"investor_profile.senior_executive_symbols",
"investor_profile.family_member_names",
"investor_profile.political_organization",
"investor_profile.funding_sources",
"document.id_card.front.image",
"document.id_card.front.latest_upload",
"document.id_card.front.mime_type",
"document.id_card.back.image",
"document.id_card.back.latest_upload",
"document.id_card.back.mime_type",
"document.id_card.selfie.image",
"document.id_card.selfie.latest_upload",
"document.id_card.selfie.mime_type",
"document.id_card.full_name",
"document.id_card.first_name",
"document.id_card.last_name",
"document.id_card.dob",
"document.id_card.gender",
"document.id_card.full_address",
"document.id_card.address_line1",
"document.id_card.city",
"document.id_card.state",
"document.id_card.country",
"document.id_card.postal_code",
"document.id_card.document_number",
"document.id_card.expires_at",
"document.id_card.issued_at",
"document.id_card.issuing_state",
"document.id_card.issuing_country",
"document.id_card.ref_number",
"document.id_card.nationality",
"document.id_card.curp",
"document.id_card.clave_de_elector",
"document.id_card.classified_document_type",
"document.id_card.curp_validation_response",
"document.id_card.samba_activity_history_response",
"document.id_card.us_issuing_state",
"document.drivers_license.front.image",
"document.drivers_license.front.latest_upload",
"document.drivers_license.front.mime_type",
"document.drivers_license.back.image",
"document.drivers_license.back.latest_upload",
"document.drivers_license.back.mime_type",
"document.drivers_license.selfie.image",
"document.drivers_license.selfie.latest_upload",
"document.drivers_license.selfie.mime_type",
"document.drivers_license.full_name",
"document.drivers_license.first_name",
"document.drivers_license.last_name",
"document.drivers_license.dob",
"document.drivers_license.gender",
"document.drivers_license.full_address",
"document.drivers_license.address_line1",
"document.drivers_license.city",
"document.drivers_license.state",
"document.drivers_license.country",
"document.drivers_license.postal_code",
"document.drivers_license.document_number",
"document.drivers_license.expires_at",
"document.drivers_license.issued_at",
"document.drivers_license.issuing_state",
"document.drivers_license.issuing_country",
"document.drivers_license.ref_number",
"document.drivers_license.nationality",
"document.drivers_license.curp",
"document.drivers_license.clave_de_elector",
"document.drivers_license.classified_document_type",
"document.drivers_license.curp_validation_response",
"document.drivers_license.samba_activity_history_response",
"document.drivers_license.us_issuing_state",
"document.passport.front.image",
"document.passport.front.latest_upload",
"document.passport.front.mime_type",
"document.passport.back.image",
"document.passport.back.latest_upload",
"document.passport.back.mime_type",
"document.passport.selfie.image",
"document.passport.selfie.latest_upload",
"document.passport.selfie.mime_type",
"document.passport.full_name",
"document.passport.first_name",
"document.passport.last_name",
"document.passport.dob",
"document.passport.gender",
"document.passport.full_address",
"document.passport.address_line1",
"document.passport.city",
"document.passport.state",
"document.passport.country",
"document.passport.postal_code",
"document.passport.document_number",
"document.passport.expires_at",
"document.passport.issued_at",
"document.passport.issuing_state",
"document.passport.issuing_country",
"document.passport.ref_number",
"document.passport.nationality",
"document.passport.curp",
"document.passport.clave_de_elector",
"document.passport.classified_document_type",
"document.passport.curp_validation_response",
"document.passport.samba_activity_history_response",
"document.passport.us_issuing_state",
"document.passport_card.front.image",
"document.passport_card.front.latest_upload",
"document.passport_card.front.mime_type",
"document.passport_card.back.image",
"document.passport_card.back.latest_upload",
"document.passport_card.back.mime_type",
"document.passport_card.selfie.image",
"document.passport_card.selfie.latest_upload",
"document.passport_card.selfie.mime_type",
"document.passport_card.full_name",
"document.passport_card.first_name",
"document.passport_card.last_name",
"document.passport_card.dob",
"document.passport_card.gender",
"document.passport_card.full_address",
"document.passport_card.address_line1",
"document.passport_card.city",
"document.passport_card.state",
"document.passport_card.country",
"document.passport_card.postal_code",
"document.passport_card.document_number",
"document.passport_card.expires_at",
"document.passport_card.issued_at",
"document.passport_card.issuing_state",
"document.passport_card.issuing_country",
"document.passport_card.ref_number",
"document.passport_card.nationality",
"document.passport_card.curp",
"document.passport_card.clave_de_elector",
"document.passport_card.classified_document_type",
"document.passport_card.curp_validation_response",
"document.passport_card.samba_activity_history_response",
"document.passport_card.us_issuing_state",
"document.permit.front.image",
"document.permit.front.latest_upload",
"document.permit.front.mime_type",
"document.permit.back.image",
"document.permit.back.latest_upload",
"document.permit.back.mime_type",
"document.permit.selfie.image",
"document.permit.selfie.latest_upload",
"document.permit.selfie.mime_type",
"document.permit.full_name",
"document.permit.first_name",
"document.permit.last_name",
"document.permit.dob",
"document.permit.gender",
"document.permit.full_address",
"document.permit.address_line1",
"document.permit.city",
"document.permit.state",
"document.permit.country",
"document.permit.postal_code",
"document.permit.document_number",
"document.permit.expires_at",
"document.permit.issued_at",
"document.permit.issuing_state",
"document.permit.issuing_country",
"document.permit.ref_number",
"document.permit.nationality",
"document.permit.curp",
"document.permit.clave_de_elector",
"document.permit.classified_document_type",
"document.permit.curp_validation_response",
"document.permit.samba_activity_history_response",
"document.permit.us_issuing_state",
"document.visa.front.image",
"document.visa.front.latest_upload",
"document.visa.front.mime_type",
"document.visa.back.image",
"document.visa.back.latest_upload",
"document.visa.back.mime_type",
"document.visa.selfie.image",
"document.visa.selfie.latest_upload",
"document.visa.selfie.mime_type",
"document.visa.full_name",
"document.visa.first_name",
"document.visa.last_name",
"document.visa.dob",
"document.visa.gender",
"document.visa.full_address",
"document.visa.address_line1",
"document.visa.city",
"document.visa.state",
"document.visa.country",
"document.visa.postal_code",
"document.visa.document_number",
"document.visa.expires_at",
"document.visa.issued_at",
"document.visa.issuing_state",
"document.visa.issuing_country",
"document.visa.ref_number",
"document.visa.nationality",
"document.visa.curp",
"document.visa.clave_de_elector",
"document.visa.classified_document_type",
"document.visa.curp_validation_response",
"document.visa.samba_activity_history_response",
"document.visa.us_issuing_state",
"document.residence_document.front.image",
"document.residence_document.front.latest_upload",
"document.residence_document.front.mime_type",
"document.residence_document.back.image",
"document.residence_document.back.latest_upload",
"document.residence_document.back.mime_type",
"document.residence_document.selfie.image",
"document.residence_document.selfie.latest_upload",
"document.residence_document.selfie.mime_type",
"document.residence_document.full_name",
"document.residence_document.first_name",
"document.residence_document.last_name",
"document.residence_document.dob",
"document.residence_document.gender",
"document.residence_document.full_address",
"document.residence_document.address_line1",
"document.residence_document.city",
"document.residence_document.state",
"document.residence_document.country",
"document.residence_document.postal_code",
"document.residence_document.document_number",
"document.residence_document.expires_at",
"document.residence_document.issued_at",
"document.residence_document.issuing_state",
"document.residence_document.issuing_country",
"document.residence_document.ref_number",
"document.residence_document.nationality",
"document.residence_document.curp",
"document.residence_document.clave_de_elector",
"document.residence_document.classified_document_type",
"document.residence_document.curp_validation_response",
"document.residence_document.samba_activity_history_response",
"document.residence_document.us_issuing_state",
"document.voter_identification.front.image",
"document.voter_identification.front.latest_upload",
"document.voter_identification.front.mime_type",
"document.voter_identification.back.image",
"document.voter_identification.back.latest_upload",
"document.voter_identification.back.mime_type",
"document.voter_identification.selfie.image",
"document.voter_identification.selfie.latest_upload",
"document.voter_identification.selfie.mime_type",
"document.voter_identification.full_name",
"document.voter_identification.first_name",
"document.voter_identification.last_name",
"document.voter_identification.dob",
"document.voter_identification.gender",
"document.voter_identification.full_address",
"document.voter_identification.address_line1",
"document.voter_identification.city",
"document.voter_identification.state",
"document.voter_identification.country",
"document.voter_identification.postal_code",
"document.voter_identification.document_number",
"document.voter_identification.expires_at",
"document.voter_identification.issued_at",
"document.voter_identification.issuing_state",
"document.voter_identification.issuing_country",
"document.voter_identification.ref_number",
"document.voter_identification.nationality",
"document.voter_identification.curp",
"document.voter_identification.clave_de_elector",
"document.voter_identification.classified_document_type",
"document.voter_identification.curp_validation_response",
"document.voter_identification.samba_activity_history_response",
"document.voter_identification.us_issuing_state",
"document.finra_compliance_letter",
"document.proof_of_address.image",
"document.ssn_card.image",
"document.custom.*",
"card.*.number",
"card.*.expiration",
"card.*.cvc",
"card.*.name",
"card.*.billing_address.zip",
"card.*.billing_address.country",
"card.*.expiration_month",
"card.*.expiration_year",
"card.*.number_last4",
"card.*.issuer",
"card.*.fingerprint",
"bank.*.name",
"bank.*.ach_routing_number",
"bank.*.ach_wire_routing_number",
"bank.*.ach_account_number",
"bank.*.ach_account_id",
"bank.*.account_type",
"bank.*.institution_id",
"bank.*.institution_name",
"bank.*.account_last4",
"bank.*.iban",
"bank.*.bic",
"bank.*.owners",
"bank.*.mk_link_id",
"bank.*.link_id",
"bank.*.closed",
"bank.*.fingerprint"
]
},
"UserDecryptRequest": {
"type": "object",
"properties": {
"at_onboarding_id": {
"example": null,
"description": "When provided, decrypts the user's data as it existed at the completion of the provided\n onboarding ID.",
"x_fp_preview_gate": "decrypt_by_onboarding_id",
"type": "string"
},
"fields": {
"example": [
"id.first_name",
"id.last_name"
],
"description": "List of data identifiers to decrypt. For example, `id.first_name`, `id.ssn4`,\n `custom.bank_account`",
"type": "array",
"items": {
"$ref": "#/components/schemas/UserDataIdentifier"
}
},
"reason": {
"example": "Lorem ipsum dolor",
"description": "Reason for the data decryption. This will be logged",
"type": "string"
},
"transforms": {
"example": null,
"description": "A list of filter and transform functions to apply to each decrypted datum.\n Omit or leave empty to apply no transforms.\n Can find more information on allowed transform functions on our docs",
"type": "array",
"items": {
"$ref": "#/components/schemas/FilterFunction"
}
}
},
"required": [
"fields",
"reason"
]
},
"UserDecryptResponse": {
"example": {
"id.first_name": "Jane",
"id.last_name": "Doe"
},
"description": "A key-value map with the corresponding decrypted values",
"type": "object",
"properties": {
"": {
"type": "string",
"enum": [
"id.first_name",
"id.middle_name",
"id.last_name",
"id.dob",
"id.ssn4",
"id.ssn9",
"id.address_line1",
"id.address_line2",
"id.city",
"id.state",
"id.zip",
"id.country",
"id.email",
"id.phone_number",
"id.us_legal_status",
"id.visa_kind",
"id.visa_expiration_date",
"id.nationality",
"id.citizenships",
"id.drivers_license_number",
"id.drivers_license_state",
"id.itin",
"id.us_tax_id",
"custom.*",
"investor_profile.employment_status",
"investor_profile.occupation",
"investor_profile.employer",
"investor_profile.annual_income",
"investor_profile.net_worth",
"investor_profile.investment_goals",
"investor_profile.risk_tolerance",
"investor_profile.declarations",
"investor_profile.brokerage_firm_employer",
"investor_profile.senior_executive_symbols",
"investor_profile.family_member_names",
"investor_profile.political_organization",
"investor_profile.funding_sources",
"document.id_card.front.image",
"document.id_card.front.latest_upload",
"document.id_card.front.mime_type",
"document.id_card.back.image",
"document.id_card.back.latest_upload",
"document.id_card.back.mime_type",
"document.id_card.selfie.image",
"document.id_card.selfie.latest_upload",
"document.id_card.selfie.mime_type",
"document.id_card.full_name",
"document.id_card.first_name",
"document.id_card.last_name",
"document.id_card.dob",
"document.id_card.gender",
"document.id_card.full_address",
"document.id_card.address_line1",
"document.id_card.city",
"document.id_card.state",
"document.id_card.country",
"document.id_card.postal_code",
"document.id_card.document_number",
"document.id_card.expires_at",
"document.id_card.issued_at",
"document.id_card.issuing_state",
"document.id_card.issuing_country",
"document.id_card.ref_number",
"document.id_card.nationality",
"document.id_card.curp",
"document.id_card.clave_de_elector",
"document.id_card.classified_document_type",
"document.id_card.curp_validation_response",
"document.id_card.samba_activity_history_response",
"document.id_card.us_issuing_state",
"document.drivers_license.front.image",
"document.drivers_license.front.latest_upload",
"document.drivers_license.front.mime_type",
"document.drivers_license.back.image",
"document.drivers_license.back.latest_upload",
"document.drivers_license.back.mime_type",
"document.drivers_license.selfie.image",
"document.drivers_license.selfie.latest_upload",
"document.drivers_license.selfie.mime_type",
"document.drivers_license.full_name",
"document.drivers_license.first_name",
"document.drivers_license.last_name",
"document.drivers_license.dob",
"document.drivers_license.gender",
"document.drivers_license.full_address",
"document.drivers_license.address_line1",
"document.drivers_license.city",
"document.drivers_license.state",
"document.drivers_license.country",
"document.drivers_license.postal_code",
"document.drivers_license.document_number",
"document.drivers_license.expires_at",
"document.drivers_license.issued_at",
"document.drivers_license.issuing_state",
"document.drivers_license.issuing_country",
"document.drivers_license.ref_number",
"document.drivers_license.nationality",
"document.drivers_license.curp",
"document.drivers_license.clave_de_elector",
"document.drivers_license.classified_document_type",
"document.drivers_license.curp_validation_response",
"document.drivers_license.samba_activity_history_response",
"document.drivers_license.us_issuing_state",
"document.passport.front.image",
"document.passport.front.latest_upload",
"document.passport.front.mime_type",
"document.passport.back.image",
"document.passport.back.latest_upload",
"document.passport.back.mime_type",
"document.passport.selfie.image",
"document.passport.selfie.latest_upload",
"document.passport.selfie.mime_type",
"document.passport.full_name",
"document.passport.first_name",
"document.passport.last_name",
"document.passport.dob",
"document.passport.gender",
"document.passport.full_address",
"document.passport.address_line1",
"document.passport.city",
"document.passport.state",
"document.passport.country",
"document.passport.postal_code",
"document.passport.document_number",
"document.passport.expires_at",
"document.passport.issued_at",
"document.passport.issuing_state",
"document.passport.issuing_country",
"document.passport.ref_number",
"document.passport.nationality",
"document.passport.curp",
"document.passport.clave_de_elector",
"document.passport.classified_document_type",
"document.passport.curp_validation_response",
"document.passport.samba_activity_history_response",
"document.passport.us_issuing_state",
"document.passport_card.front.image",
"document.passport_card.front.latest_upload",
"document.passport_card.front.mime_type",
"document.passport_card.back.image",
"document.passport_card.back.latest_upload",
"document.passport_card.back.mime_type",
"document.passport_card.selfie.image",
"document.passport_card.selfie.latest_upload",
"document.passport_card.selfie.mime_type",
"document.passport_card.full_name",
"document.passport_card.first_name",
"document.passport_card.last_name",
"document.passport_card.dob",
"document.passport_card.gender",
"document.passport_card.full_address",
"document.passport_card.address_line1",
"document.passport_card.city",
"document.passport_card.state",
"document.passport_card.country",
"document.passport_card.postal_code",
"document.passport_card.document_number",
"document.passport_card.expires_at",
"document.passport_card.issued_at",
"document.passport_card.issuing_state",
"document.passport_card.issuing_country",
"document.passport_card.ref_number",
"document.passport_card.nationality",
"document.passport_card.curp",
"document.passport_card.clave_de_elector",
"document.passport_card.classified_document_type",
"document.passport_card.curp_validation_response",
"document.passport_card.samba_activity_history_response",
"document.passport_card.us_issuing_state",
"document.permit.front.image",
"document.permit.front.latest_upload",
"document.permit.front.mime_type",
"document.permit.back.image",
"document.permit.back.latest_upload",
"document.permit.back.mime_type",
"document.permit.selfie.image",
"document.permit.selfie.latest_upload",
"document.permit.selfie.mime_type",
"document.permit.full_name",
"document.permit.first_name",
"document.permit.last_name",
"document.permit.dob",
"document.permit.gender",
"document.permit.full_address",
"document.permit.address_line1",
"document.permit.city",
"document.permit.state",
"document.permit.country",
"document.permit.postal_code",
"document.permit.document_number",
"document.permit.expires_at",
"document.permit.issued_at",
"document.permit.issuing_state",
"document.permit.issuing_country",
"document.permit.ref_number",
"document.permit.nationality",
"document.permit.curp",
"document.permit.clave_de_elector",
"document.permit.classified_document_type",
"document.permit.curp_validation_response",
"document.permit.samba_activity_history_response",
"document.permit.us_issuing_state",
"document.visa.front.image",
"document.visa.front.latest_upload",
"document.visa.front.mime_type",
"document.visa.back.image",
"document.visa.back.latest_upload",
"document.visa.back.mime_type",
"document.visa.selfie.image",
"document.visa.selfie.latest_upload",
"document.visa.selfie.mime_type",
"document.visa.full_name",
"document.visa.first_name",
"document.visa.last_name",
"document.visa.dob",
"document.visa.gender",
"document.visa.full_address",
"document.visa.address_line1",
"document.visa.city",
"document.visa.state",
"document.visa.country",
"document.visa.postal_code",
"document.visa.document_number",
"document.visa.expires_at",
"document.visa.issued_at",
"document.visa.issuing_state",
"document.visa.issuing_country",
"document.visa.ref_number",
"document.visa.nationality",
"document.visa.curp",
"document.visa.clave_de_elector",
"document.visa.classified_document_type",
"document.visa.curp_validation_response",
"document.visa.samba_activity_history_response",
"document.visa.us_issuing_state",
"document.residence_document.front.image",
"document.residence_document.front.latest_upload",
"document.residence_document.front.mime_type",
"document.residence_document.back.image",
"document.residence_document.back.latest_upload",
"document.residence_document.back.mime_type",
"document.residence_document.selfie.image",
"document.residence_document.selfie.latest_upload",
"document.residence_document.selfie.mime_type",
"document.residence_document.full_name",
"document.residence_document.first_name",
"document.residence_document.last_name",
"document.residence_document.dob",
"document.residence_document.gender",
"document.residence_document.full_address",
"document.residence_document.address_line1",
"document.residence_document.city",
"document.residence_document.state",
"document.residence_document.country",
"document.residence_document.postal_code",
"document.residence_document.document_number",
"document.residence_document.expires_at",
"document.residence_document.issued_at",
"document.residence_document.issuing_state",
"document.residence_document.issuing_country",
"document.residence_document.ref_number",
"document.residence_document.nationality",
"document.residence_document.curp",
"document.residence_document.clave_de_elector",
"document.residence_document.classified_document_type",
"document.residence_document.curp_validation_response",
"document.residence_document.samba_activity_history_response",
"document.residence_document.us_issuing_state",
"document.voter_identification.front.image",
"document.voter_identification.front.latest_upload",
"document.voter_identification.front.mime_type",
"document.voter_identification.back.image",
"document.voter_identification.back.latest_upload",
"document.voter_identification.back.mime_type",
"document.voter_identification.selfie.image",
"document.voter_identification.selfie.latest_upload",
"document.voter_identification.selfie.mime_type",
"document.voter_identification.full_name",
"document.voter_identification.first_name",
"document.voter_identification.last_name",
"document.voter_identification.dob",
"document.voter_identification.gender",
"document.voter_identification.full_address",
"document.voter_identification.address_line1",
"document.voter_identification.city",
"document.voter_identification.state",
"document.voter_identification.country",
"document.voter_identification.postal_code",
"document.voter_identification.document_number",
"document.voter_identification.expires_at",
"document.voter_identification.issued_at",
"document.voter_identification.issuing_state",
"document.voter_identification.issuing_country",
"document.voter_identification.ref_number",
"document.voter_identification.nationality",
"document.voter_identification.curp",
"document.voter_identification.clave_de_elector",
"document.voter_identification.classified_document_type",
"document.voter_identification.curp_validation_response",
"document.voter_identification.samba_activity_history_response",
"document.voter_identification.us_issuing_state",
"document.finra_compliance_letter",
"document.proof_of_address.image",
"document.ssn_card.image",
"document.custom.*",
"card.*.number",
"card.*.expiration",
"card.*.cvc",
"card.*.name",
"card.*.billing_address.zip",
"card.*.billing_address.country",
"card.*.expiration_month",
"card.*.expiration_year",
"card.*.number_last4",
"card.*.issuer",
"card.*.fingerprint",
"bank.*.name",
"bank.*.ach_routing_number",
"bank.*.ach_wire_routing_number",
"bank.*.ach_account_number",
"bank.*.ach_account_id",
"bank.*.account_type",
"bank.*.institution_id",
"bank.*.institution_name",
"bank.*.account_last4",
"bank.*.iban",
"bank.*.bic",
"bank.*.owners",
"bank.*.mk_link_id",
"bank.*.link_id",
"bank.*.closed",
"bank.*.fingerprint"
]
},
"": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer",
"format": "int64"
},
{
"type": "boolean"
},
{
"type": "object"
}
]
}
},
"required": [
"",
""
]
},
"UserDeleteResponse": {
"example": {
"id.first_name": true,
"id.last_name": false
},
"description": "A key-value map of identifier to whether the identifier was successfully deleted in the vault",
"type": "object",
"properties": {
"": {
"type": "string",
"enum": [
"id.first_name",
"id.middle_name",
"id.last_name",
"id.dob",
"id.ssn4",
"id.ssn9",
"id.address_line1",
"id.address_line2",
"id.city",
"id.state",
"id.zip",
"id.country",
"id.email",
"id.phone_number",
"id.us_legal_status",
"id.visa_kind",
"id.visa_expiration_date",
"id.nationality",
"id.citizenships",
"id.drivers_license_number",
"id.drivers_license_state",
"id.itin",
"id.us_tax_id",
"custom.*",
"investor_profile.employment_status",
"investor_profile.occupation",
"investor_profile.employer",
"investor_profile.annual_income",
"investor_profile.net_worth",
"investor_profile.investment_goals",
"investor_profile.risk_tolerance",
"investor_profile.declarations",
"investor_profile.brokerage_firm_employer",
"investor_profile.senior_executive_symbols",
"investor_profile.family_member_names",
"investor_profile.political_organization",
"investor_profile.funding_sources",
"document.id_card.front.image",
"document.id_card.front.latest_upload",
"document.id_card.front.mime_type",
"document.id_card.back.image",
"document.id_card.back.latest_upload",
"document.id_card.back.mime_type",
"document.id_card.selfie.image",
"document.id_card.selfie.latest_upload",
"document.id_card.selfie.mime_type",
"document.id_card.full_name",
"document.id_card.first_name",
"document.id_card.last_name",
"document.id_card.dob",
"document.id_card.gender",
"document.id_card.full_address",
"document.id_card.address_line1",
"document.id_card.city",
"document.id_card.state",
"document.id_card.country",
"document.id_card.postal_code",
"document.id_card.document_number",
"document.id_card.expires_at",
"document.id_card.issued_at",
"document.id_card.issuing_state",
"document.id_card.issuing_country",
"document.id_card.ref_number",
"document.id_card.nationality",
"document.id_card.curp",
"document.id_card.clave_de_elector",
"document.id_card.classified_document_type",
"document.id_card.curp_validation_response",
"document.id_card.samba_activity_history_response",
"document.id_card.us_issuing_state",
"document.drivers_license.front.image",
"document.drivers_license.front.latest_upload",
"document.drivers_license.front.mime_type",
"document.drivers_license.back.image",
"document.drivers_license.back.latest_upload",
"document.drivers_license.back.mime_type",
"document.drivers_license.selfie.image",
"document.drivers_license.selfie.latest_upload",
"document.drivers_license.selfie.mime_type",
"document.drivers_license.full_name",
"document.drivers_license.first_name",
"document.drivers_license.last_name",
"document.drivers_license.dob",
"document.drivers_license.gender",
"document.drivers_license.full_address",
"document.drivers_license.address_line1",
"document.drivers_license.city",
"document.drivers_license.state",
"document.drivers_license.country",
"document.drivers_license.postal_code",
"document.drivers_license.document_number",
"document.drivers_license.expires_at",
"document.drivers_license.issued_at",
"document.drivers_license.issuing_state",
"document.drivers_license.issuing_country",
"document.drivers_license.ref_number",
"document.drivers_license.nationality",
"document.drivers_license.curp",
"document.drivers_license.clave_de_elector",
"document.drivers_license.classified_document_type",
"document.drivers_license.curp_validation_response",
"document.drivers_license.samba_activity_history_response",
"document.drivers_license.us_issuing_state",
"document.passport.front.image",
"document.passport.front.latest_upload",
"document.passport.front.mime_type",
"document.passport.back.image",
"document.passport.back.latest_upload",
"document.passport.back.mime_type",
"document.passport.selfie.image",
"document.passport.selfie.latest_upload",
"document.passport.selfie.mime_type",
"document.passport.full_name",
"document.passport.first_name",
"document.passport.last_name",
"document.passport.dob",
"document.passport.gender",
"document.passport.full_address",
"document.passport.address_line1",
"document.passport.city",
"document.passport.state",
"document.passport.country",
"document.passport.postal_code",
"document.passport.document_number",
"document.passport.expires_at",
"document.passport.issued_at",
"document.passport.issuing_state",
"document.passport.issuing_country",
"document.passport.ref_number",
"document.passport.nationality",
"document.passport.curp",
"document.passport.clave_de_elector",
"document.passport.classified_document_type",
"document.passport.curp_validation_response",
"document.passport.samba_activity_history_response",
"document.passport.us_issuing_state",
"document.passport_card.front.image",
"document.passport_card.front.latest_upload",
"document.passport_card.front.mime_type",
"document.passport_card.back.image",
"document.passport_card.back.latest_upload",
"document.passport_card.back.mime_type",
"document.passport_card.selfie.image",
"document.passport_card.selfie.latest_upload",
"document.passport_card.selfie.mime_type",
"document.passport_card.full_name",
"document.passport_card.first_name",
"document.passport_card.last_name",
"document.passport_card.dob",
"document.passport_card.gender",
"document.passport_card.full_address",
"document.passport_card.address_line1",
"document.passport_card.city",
"document.passport_card.state",
"document.passport_card.country",
"document.passport_card.postal_code",
"document.passport_card.document_number",
"document.passport_card.expires_at",
"document.passport_card.issued_at",
"document.passport_card.issuing_state",
"document.passport_card.issuing_country",
"document.passport_card.ref_number",
"document.passport_card.nationality",
"document.passport_card.curp",
"document.passport_card.clave_de_elector",
"document.passport_card.classified_document_type",
"document.passport_card.curp_validation_response",
"document.passport_card.samba_activity_history_response",
"document.passport_card.us_issuing_state",
"document.permit.front.image",
"document.permit.front.latest_upload",
"document.permit.front.mime_type",
"document.permit.back.image",
"document.permit.back.latest_upload",
"document.permit.back.mime_type",
"document.permit.selfie.image",
"document.permit.selfie.latest_upload",
"document.permit.selfie.mime_type",
"document.permit.full_name",
"document.permit.first_name",
"document.permit.last_name",
"document.permit.dob",
"document.permit.gender",
"document.permit.full_address",
"document.permit.address_line1",
"document.permit.city",
"document.permit.state",
"document.permit.country",
"document.permit.postal_code",
"document.permit.document_number",
"document.permit.expires_at",
"document.permit.issued_at",
"document.permit.issuing_state",
"document.permit.issuing_country",
"document.permit.ref_number",
"document.permit.nationality",
"document.permit.curp",
"document.permit.clave_de_elector",
"document.permit.classified_document_type",
"document.permit.curp_validation_response",
"document.permit.samba_activity_history_response",
"document.permit.us_issuing_state",
"document.visa.front.image",
"document.visa.front.latest_upload",
"document.visa.front.mime_type",
"document.visa.back.image",
"document.visa.back.latest_upload",
"document.visa.back.mime_type",
"document.visa.selfie.image",
"document.visa.selfie.latest_upload",
"document.visa.selfie.mime_type",
"document.visa.full_name",
"document.visa.first_name",
"document.visa.last_name",
"document.visa.dob",
"document.visa.gender",
"document.visa.full_address",
"document.visa.address_line1",
"document.visa.city",
"document.visa.state",
"document.visa.country",
"document.visa.postal_code",
"document.visa.document_number",
"document.visa.expires_at",
"document.visa.issued_at",
"document.visa.issuing_state",
"document.visa.issuing_country",
"document.visa.ref_number",
"document.visa.nationality",
"document.visa.curp",
"document.visa.clave_de_elector",
"document.visa.classified_document_type",
"document.visa.curp_validation_response",
"document.visa.samba_activity_history_response",
"document.visa.us_issuing_state",
"document.residence_document.front.image",
"document.residence_document.front.latest_upload",
"document.residence_document.front.mime_type",
"document.residence_document.back.image",
"document.residence_document.back.latest_upload",
"document.residence_document.back.mime_type",
"document.residence_document.selfie.image",
"document.residence_document.selfie.latest_upload",
"document.residence_document.selfie.mime_type",
"document.residence_document.full_name",
"document.residence_document.first_name",
"document.residence_document.last_name",
"document.residence_document.dob",
"document.residence_document.gender",
"document.residence_document.full_address",
"document.residence_document.address_line1",
"document.residence_document.city",
"document.residence_document.state",
"document.residence_document.country",
"document.residence_document.postal_code",
"document.residence_document.document_number",
"document.residence_document.expires_at",
"document.residence_document.issued_at",
"document.residence_document.issuing_state",
"document.residence_document.issuing_country",
"document.residence_document.ref_number",
"document.residence_document.nationality",
"document.residence_document.curp",
"document.residence_document.clave_de_elector",
"document.residence_document.classified_document_type",
"document.residence_document.curp_validation_response",
"document.residence_document.samba_activity_history_response",
"document.residence_document.us_issuing_state",
"document.voter_identification.front.image",
"document.voter_identification.front.latest_upload",
"document.voter_identification.front.mime_type",
"document.voter_identification.back.image",
"document.voter_identification.back.latest_upload",
"document.voter_identification.back.mime_type",
"document.voter_identification.selfie.image",
"document.voter_identification.selfie.latest_upload",
"document.voter_identification.selfie.mime_type",
"document.voter_identification.full_name",
"document.voter_identification.first_name",
"document.voter_identification.last_name",
"document.voter_identification.dob",
"document.voter_identification.gender",
"document.voter_identification.full_address",
"document.voter_identification.address_line1",
"document.voter_identification.city",
"document.voter_identification.state",
"document.voter_identification.country",
"document.voter_identification.postal_code",
"document.voter_identification.document_number",
"document.voter_identification.expires_at",
"document.voter_identification.issued_at",
"document.voter_identification.issuing_state",
"document.voter_identification.issuing_country",
"document.voter_identification.ref_number",
"document.voter_identification.nationality",
"document.voter_identification.curp",
"document.voter_identification.clave_de_elector",
"document.voter_identification.classified_document_type",
"document.voter_identification.curp_validation_response",
"document.voter_identification.samba_activity_history_response",
"document.voter_identification.us_issuing_state",
"document.finra_compliance_letter",
"document.proof_of_address.image",
"document.ssn_card.image",
"document.custom.*",
"card.*.number",
"card.*.expiration",
"card.*.cvc",
"card.*.name",
"card.*.billing_address.zip",
"card.*.billing_address.country",
"card.*.expiration_month",
"card.*.expiration_year",
"card.*.number_last4",
"card.*.issuer",
"card.*.fingerprint",
"bank.*.name",
"bank.*.ach_routing_number",
"bank.*.ach_wire_routing_number",
"bank.*.ach_account_number",
"bank.*.ach_account_id",
"bank.*.account_type",
"bank.*.institution_id",
"bank.*.institution_name",
"bank.*.account_last4",
"bank.*.iban",
"bank.*.bic",
"bank.*.owners",
"bank.*.mk_link_id",
"bank.*.link_id",
"bank.*.closed",
"bank.*.fingerprint"
]
},
"": {
"type": "boolean"
}
},
"required": [
"",
""
]
},
"UserInfoRequestedPayload": {
"example": {
"event_kind": "footprint.user.info_requested",
"fp_id": "fp_id_xyz",
"timestamp": "2024-06-14T02:40:00Z",
"is_live": false,
"external_id": null
},
"title": "footprint.user.info_requested",
"description": "A Footprint dashboard user has requested this user to provide more information during the course of manual review. When responding to this webhook, you can see more context on the information requested using the GET /users/{fp_id} API.",
"type": "object",
"properties": {
"event_kind": {
"type": "string",
"enum": [
"footprint.user.info_requested"
]
},
"external_id": {
"type": "string"
},
"fp_id": {
"type": "string"
},
"is_live": {
"type": "boolean"
},
"timestamp": {
"type": "string",
"format": "date-time"
}
},
"required": [
"event_kind",
"fp_id",
"is_live",
"timestamp"
]
},
"UserLabel": {
"type": "object",
"properties": {
"created_at": {
"type": "string",
"format": "date-time"
},
"kind": {
"$ref": "#/components/schemas/LabelKind"
}
}
},
"UserManualReviewPayload": {
"example": {
"event_kind": "footprint.user.manual_review",
"fp_id": "fp_id_xyz",
"timestamp": "2024-06-14T02:40:00Z",
"is_live": false,
"external_id": null
},
"title": "footprint.user.manual_review",
"description": "A Footprint dashboard user has changed the user's status during manual review. When responding to this webhook, you can see more context on the user's up-to-date status using the GET /users/{fp_id} API.",
"type": "object",
"properties": {
"event_kind": {
"type": "string",
"enum": [
"footprint.user.manual_review"
]
},
"external_id": {
"type": "string"
},
"fp_id": {
"type": "string"
},
"is_live": {
"type": "boolean"
},
"timestamp": {
"type": "string",
"format": "date-time"
}
},
"required": [
"event_kind",
"fp_id",
"is_live",
"timestamp"
]
},
"UserTag": {
"type": "object",
"properties": {
"created_at": {
"type": "string",
"format": "date-time"
},
"id": {
"example": "tag_2ZwAl6LyHB6l7Ap2Ksdw8X",
"type": "string"
},
"tag": {
"example": "transaction_chargeback",
"type": "string"
}
},
"required": [
"created_at",
"id",
"tag"
]
},
"UserVaultUpdateSource": {
"type": "string",
"enum": [
"dashboard",
"update_auth_methods"
]
},
"UserVaultUpdatedPayload": {
"example": {
"event_kind": "footprint.vault.updated",
"fp_id": "fp_id_xyz",
"timestamp": "2024-06-14T02:40:00Z",
"is_live": false,
"source": "dashboard",
"fields": [
"id.ssn9",
"id.first_name"
],
"external_id": null
},
"title": "footprint.vault.updated",
"description": "A Footprint user or business vault was updated.",
"type": "object",
"properties": {
"event_kind": {
"type": "string",
"enum": [
"footprint.vault.updated"
]
},
"external_id": {
"type": "string"
},
"fields": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DataIdentifier"
}
},
"fp_id": {
"type": "string"
},
"is_live": {
"type": "boolean"
},
"source": {
"$ref": "#/components/schemas/UserVaultUpdateSource"
},
"timestamp": {
"type": "string",
"format": "date-time"
}
},
"required": [
"event_kind",
"fields",
"fp_id",
"is_live",
"source",
"timestamp"
]
},
"ValidateAuthEvent": {
"type": "object",
"properties": {
"kind": {
"$ref": "#/components/schemas/AuthEventKind"
},
"timestamp": {
"type": "string",
"format": "date-time"
}
},
"required": [
"kind",
"timestamp"
]
},
"ValidateRequest": {
"type": "object",
"properties": {
"validation_token": {
"example": "vtok_UxM6Vbvk2Rcy1gzcSuXgk3sj3L9I0pAnNH",
"description": "The validation token given from either the `onComplete` or `onAuth` callback of the\n Footprint SDK.",
"type": "string"
}
},
"required": [
"validation_token"
]
},
"ValidateResponse": {
"type": "object",
"properties": {
"bank_link": {
"allOf": [
{
"$ref": "#/components/schemas/BankLinkingValidateResponse"
},
{
"example": null,
"description": "information about the linked bank account if onboarding to a bank linking playbook.",
"type": "object"
}
]
},
"business": {
"allOf": [
{
"$ref": "#/components/schemas/EntityValidateResponse"
},
{
"example": null,
"description": "Information on the business and its onboarding session. Provided after onboarding onto a KYB\n playbook.",
"type": "object"
}
]
},
"user": {
"allOf": [
{
"$ref": "#/components/schemas/EntityValidateResponse"
},
{
"description": "Information on the user and their onboarding session. Provided after onboarding onto a KYC\n or KYB playbook.",
"type": "object"
}
]
},
"user_auth": {
"allOf": [
{
"$ref": "#/components/schemas/UserAuthResponse"
},
{
"description": "Information on the authenticated user and the auth method they used.",
"type": "object"
}
]
}
},
"required": [
"user_auth"
]
},
"VaultKind": {
"type": "string",
"enum": [
"person",
"business"
]
},
"Vendor": {
"type": "string",
"enum": [
"footprint",
"idology",
"lexis",
"experian",
"twilio",
"middesk",
"incode",
"neuro_id",
"samba_safety",
"sentilink",
"comply_advantage",
"base_layer",
"verified",
"fingerprint_js",
"taktile",
"resistant"
]
},
"WatchlistCheckCompletedPayload": {
"example": {
"event_kind": "footprint.watchlist_check.completed",
"fp_id": "fp_id_xyz",
"timestamp": "2024-06-14T02:40:00Z",
"status": "pending",
"error": null,
"is_live": false,
"onboarding_id": "ob_SRFT2a1mN7DAWJ0VPXkiqK",
"external_id": null
},
"title": "footprint.watchlist_check.completed",
"description": "A watchlist check has run for the user.",
"type": "object",
"properties": {
"error": {
"$ref": "#/components/schemas/WatchlistCheckError"
},
"event_kind": {
"type": "string",
"enum": [
"footprint.watchlist_check.completed"
]
},
"external_id": {
"type": "string"
},
"fp_id": {
"type": "string"
},
"is_live": {
"type": "boolean"
},
"onboarding_id": {
"type": "string"
},
"status": {
"$ref": "#/components/schemas/WatchlistCheckStatusKind"
},
"timestamp": {
"type": "string",
"format": "date-time"
}
},
"required": [
"event_kind",
"fp_id",
"is_live",
"onboarding_id",
"status",
"timestamp"
]
},
"WatchlistCheckError": {
"type": "string",
"enum": [
"required_data_not_present"
]
},
"WatchlistCheckStatusKind": {
"type": "string",
"enum": [
"pending",
"pass",
"fail",
"error",
"not_needed",
"repeated_hits",
"initial_kyc_record"
]
},
"WatchlistEntry": {
"description": "Watchlist screening result for a single screened entity.",
"type": "object",
"properties": {
"hits": {
"description": "Watchlist hits found for this entity, if any.",
"type": "array",
"items": {
"$ref": "#/components/schemas/WatchlistHit"
}
},
"screened_entity_name": {
"description": "The name that was screened against watchlists.",
"type": "string"
}
},
"required": [
"hits"
]
},
"WatchlistHit": {
"description": "A single watchlist hit for a screened entity.",
"type": "object",
"properties": {
"agency": {
"description": "Full name of the agency that maintains this watchlist.",
"type": "string"
},
"agency_abbr": {
"description": "Abbreviated name of the issuing agency (e.g. `\"OFAC\"`, `\"BIS\"`).",
"type": "string"
},
"agency_information_url": {
"description": "URL with additional information from the issuing agency.",
"type": "string"
},
"agency_list_url": {
"description": "URL to the watchlist maintained by the issuing agency.",
"type": "string"
},
"entity_addresses": {
"description": "Known addresses for the watchlisted entity.",
"type": "array",
"items": {
"type": "string"
}
},
"entity_aliases": {
"description": "Known aliases for the watchlisted entity.",
"type": "array",
"items": {
"type": "string"
}
},
"entity_name": {
"description": "Name of the entity on the watchlist.",
"type": "string"
},
"list_country": {
"description": "Country associated with this watchlist.",
"type": "string"
},
"list_name": {
"description": "Name of the specific watchlist (e.g. `\"SDN\"`, `\"Entity List\"`).",
"type": "string"
},
"url": {
"description": "Direct URL to this specific watchlist entry, if available.",
"type": "string"
}
},
"required": [
"entity_addresses",
"entity_aliases"
]
},
"WebhookEvent": {
"example": {
"event_kind": "footprint.onboarding.completed",
"fp_id": "fp_id_xyz",
"timestamp": "2024-06-14T02:40:00Z",
"status": "pass",
"playbook_key": "pb_test_QoEYTOve49Q2IAmaKVYnPs",
"requires_manual_review": false,
"is_live": false,
"onboarding_id": "ob_SRFT2a1mN7DAWJ0VPXkiqK",
"external_id": null,
"onboarding_external_id": null
},
"description": "Defines the supported webhook event payload kinds",
"anyOf": [
{
"$ref": "#/components/schemas/OnboardingCompletedPayload"
},
{
"$ref": "#/components/schemas/WatchlistCheckCompletedPayload"
},
{
"$ref": "#/components/schemas/UserInfoRequestedPayload"
},
{
"$ref": "#/components/schemas/UserManualReviewPayload"
},
{
"$ref": "#/components/schemas/UserVaultUpdatedPayload"
},
{
"$ref": "#/components/schemas/UserBankLinkUpdatedPayload"
},
{
"$ref": "#/components/schemas/EntityStatusChangedPayload"
}
]
}
}
},
"tags": [
{
"name": "PublicTenantApi"
},
{
"name": "PreviewTenantApi"
}
]
}