Footprint

https://docs.onefootprint.com
Admin
Footprint is a customer onboarding platform that unifies identity verification, bank account...
Tokens:96,608
Snippets:551
Trust Score:8.7
Update:5 months ago
Show doc for...
Tokens:
Raw
### Business Onboarding Response Example

Source: https://docs.onefootprint.com/api-reference

Example JSON response structure for listing business onboardings, including external ID, onboarding ID, playbook key, status, and timestamp.

```json
{
  "data": [
    {
      "external_id": "0cece047-151f-4ac4-9782-dc27691fd766",
      "id": "ob_SRFT2a1mN7DAWJ0VPXkiqK",
      "playbook_key": "pb_live_fZvYlX3JpanlQ3MAwE45g0",
      "status": "pass",
      "timestamp": "2022-01-04T12:00-07:00"
    },
    {
      "external_id": "0cece047-151f-4ac4-9782-dc27691fd766",
      "id": "ob_SRFT2a1mN7DAWJ0VPXkiqK",
      "playbook_key": "pb_live_fZvYlX3JpanlQ3MAwE45g0",
      "status": "pass",
      "timestamp": "2022-01-04T12:00-07:00"
    }
  ],
  "meta": {
    "next_page": 2
  }
}
```

--------------------------------

### Install @onefootprint/footprint-js

Source: https://docs.onefootprint.com/articles/guides/bank-linking

Install the Footprint JavaScript SDK. Ensure you are using version 5.0.0 or higher.

```bash
npm install @onefootprint/footprint-js
```

--------------------------------

### Authentication Examples

Source: https://docs.onefootprint.com/api-reference

Examples demonstrating how to authenticate API requests using either header-based authentication or HTTP Basic Authentication.

```APIDOC
## Authentication
The Footprint API uses API keys to authenticate requests. You can view and manage your API keys in the developer dashboard.

### Header Authentication
```
curl https://api.onefootprint.com/users \
  -H "X-Footprint-Secret-Key: sk_test_xxxxx"
```

### HTTP Basic Authentication
```
curl https://api.onefootprint.com/users \
  -u sk_test_xxxxx:
# The colon prevents curl from asking for a password.
```
```

--------------------------------

### Response Example for Business Onboarding Details

Source: https://docs.onefootprint.com/api-reference

This is an example of the JSON response structure when retrieving business onboarding details. It includes addresses, entity details, names, associated people, registrations, and watchlist information.

```json
{
  "addresses": [
    {
      "address_line1": "Lorem ipsum dolor",
      "address_line2": "Lorem ipsum dolor",
      "city": "Lorem ipsum dolor",
      "cmra": true,
      "deliverable": true,
      "latitude": 1,
      "longitude": 1,
      "postal_code": "Lorem ipsum dolor",
      "property_type": "Lorem ipsum dolor",
      "sources": "Lorem ipsum dolor",
      "state": "Lorem ipsum dolor",
      "submitted": true,
      "verified": true
    },
    {
      "address_line1": "Lorem ipsum dolor",
      "address_line2": "Lorem ipsum dolor",
      "city": "Lorem ipsum dolor",
      "cmra": true,
      "deliverable": true,
      "latitude": 1,
      "longitude": 1,
      "postal_code": "Lorem ipsum dolor",
      "property_type": "Lorem ipsum dolor",
      "sources": "Lorem ipsum dolor",
      "state": "Lorem ipsum dolor",
      "submitted": true,
      "verified": true
    }
  ],
  "details": {
    "entity_type": "Lorem ipsum dolor",
    "formation_date": "Lorem ipsum dolor",
    "formation_state": "Lorem ipsum dolor",
    "phone_numbers": [
      {
        "phone": "Lorem ipsum dolor",
        "submitted": true,
        "verified": true
      },
      {
        "phone": "Lorem ipsum dolor",
        "submitted": true,
        "verified": true
      }
    ],
    "tin": {
      "potential_match": "Lorem ipsum dolor",
      "tin": "Lorem ipsum dolor",
      "verified": true
    },
    "website": {
      "url": "Lorem ipsum dolor",
      "verified": true
    }
  },
  "names": [
    {
      "kind": "Lorem ipsum dolor",
      "name": "Lorem ipsum dolor",
      "sources": "Lorem ipsum dolor",
      "sub_status": "Lorem ipsum dolor",
      "submitted": true,
      "verified": true
    },
    {
      "kind": "Lorem ipsum dolor",
      "name": "Lorem ipsum dolor",
      "sources": "Lorem ipsum dolor",
      "sub_status": "Lorem ipsum dolor",
      "submitted": true,
      "verified": true
    }
  ],
  "people": [
    {
      "association_verified": true,
      "name": "Lorem ipsum dolor",
      "role": "Lorem ipsum dolor",
      "sources": "Lorem ipsum dolor",
      "submitted": true
    },
    {
      "association_verified": true,
      "name": "Lorem ipsum dolor",
      "role": "Lorem ipsum dolor",
      "sources": "Lorem ipsum dolor",
      "submitted": true
    }
  ],
  "registrations": [
    {
      "addresses": [
        "Lorem ipsum dolor",
        "Lorem ipsum dolor"
      ],
      "entity_type": "Lorem ipsum dolor",
      "file_number": "Lorem ipsum dolor",
      "jurisdiction": "Lorem ipsum dolor",
      "name": "Lorem ipsum dolor",
      "officers": [
        {
          "name": "Lorem ipsum dolor",
          "roles": "Lorem ipsum dolor"
        },
        {
          "name": "Lorem ipsum dolor",
          "roles": "Lorem ipsum dolor"
        }
      ],
      "registered_agent": "Lorem ipsum dolor",
      "registration_date": "Lorem ipsum dolor",
      "source": "Lorem ipsum dolor",
      "state": "Lorem ipsum dolor",
      "status": "Lorem ipsum dolor",
      "sub_status": "Lorem ipsum dolor"
    },
    {
      "addresses": [
        "Lorem ipsum dolor",
        "Lorem ipsum dolor"
      ],
      "entity_type": "Lorem ipsum dolor",
      "file_number": "Lorem ipsum dolor",
      "jurisdiction": "Lorem ipsum dolor",
      "name": "Lorem ipsum dolor",
      "officers": [
        {
          "name": "Lorem ipsum dolor",
          "roles": "Lorem ipsum dolor"
        },
        {
          "name": "Lorem ipsum dolor",
          "roles": "Lorem ipsum dolor"
        }
      ],
      "registered_agent": "Lorem ipsum dolor",
      "registration_date": "Lorem ipsum dolor",
      "source": "Lorem ipsum dolor",
      "state": "Lorem ipsum dolor",
      "status": "Lorem ipsum dolor",
      "sub_status": "Lorem ipsum dolor"
    }
  ],
  "watchlist": {
    "business": [
      {
        "hits": [
          {
            "agency": "Lorem ipsum dolor",
            "agency_abbr": "Lorem ipsum dolor",
            "agency_information_url": "Lorem ipsum dolor",
            "agency_list_url": "Lorem ipsum dolor",
            "entity_addresses": [
              "Lorem ipsum dolor",
              "Lorem ipsum dolor"
            ],
            "entity_aliases": [
              "Lorem ipsum dolor",
              "Lorem ipsum dolor"
            ],
            "entity_name": "Lorem ipsum dolor",
            "list_country": "Lorem ipsum dolor",
            "list_name": "Lorem ipsum dolor",
            "url": "Lorem ipsum dolor"
          },
          {
            "agency": "Lorem ipsum dolor",
            "agency_abbr": "Lorem ipsum dolor",
            "agency_information_url": "Lorem ipsum dolor",
            "agency_list_url": "Lorem ipsum dolor",
            "entity_addresses": [
              "Lorem ipsum dolor",
              "Lorem ipsum dolor"
            ],
            "entity_aliases": [
              "Lorem ipsum dolor",
              "Lorem ipsum dolor"
            ],
            "entity_name": "Lorem ipsum dolor",
            "list_country": "Lorem ipsum dolor",
            "list_name": "Lorem ipsum dolor",
            "url": "Lorem ipsum dolor"
          }
        ]
      }
    ]
  }
}
```

--------------------------------

### User Documents Response Example

Source: https://docs.onefootprint.com/api-reference

Example JSON response when listing documents for a user.

```json
[
  {
    "created_at": "2022-01-04T12:00-07:00",
    "document_type": "id_card",
    "id": "id_nDtKC0iGmi3klqpHJd5KoS",
    "images": {
      "back": {
        "identifier": "id.first_name",
        "version": 1
      },
      "front": {
        "identifier": "id.first_name",
        "version": 1
      },
      "selfie": {
        "identifier": "id.first_name",
        "version": 1
      }
    },
    "onboarding_id": "Lorem ipsum dolor"
  },
  {
    "created_at": "2022-01-04T12:00-07:00",
    "document_type": "id_card",
    "id": "id_nDtKC0iGmi3klqpHJd5KoS",
    "images": {
      "back": {
        "identifier": "id.first_name",
        "version": 1
      },
      "front": {
        "identifier": "id.first_name",
        "version": 1
      },
      "selfie": {
        "identifier": "id.first_name",
        "version": 1
      }
    },
    "onboarding_id": "Lorem ipsum dolor"
  }
]
```

--------------------------------

### Initialize Footprint SDK for iOS (SwiftUI)

Source: https://docs.onefootprint.com/articles/guide/definitive-integration-guide

Initialize the Footprint SDK in a SwiftUI application. This example demonstrates launching the hosted verification flow and handling completion, cancellation, or errors.

```swift
import SwiftUI
import Footprint

struct ContentView: View {
    var body: some View {
        VStack {
            Button("Verify Identity") {
                Task {
                    do {
                            // replace with the `token` from the api response
                        try await Footprint.shared.initializeWithAuthToken(authToken: "obtok_UxM6Vbvk2Rcy1gzcSuXgk3sj3L9I0pAnNH")                       
                    
                        try await FootprintHosted.shared.launchHosted(
                            onComplete: { validationToken in
                                print("Handoff completed successfully with token: \(validationToken)")
                            },
                            onCancel: {
                                print("Handoff was canceled by the user")
                            },
                            onError: { error in
                                print("Error occurred during handoff: \(error)")
                            }                            
                        )
                    } catch {
                        print("Error: \(error)")
                    }
                }
            }
        }
    }
}
```

--------------------------------

### Get Business Onboarding Status

Source: https://docs.onefootprint.com/api-reference

Retrieves the latest information about a business's onboarding process, identified by `fp_bid` and onboarding `id`.

```bash
curl https://api.onefootprint.com/businesses/{fp_bid}/onboardings/{id} \
  -u sk_test_xxxxx:
```

--------------------------------

### Get Specific User Onboarding

Source: https://docs.onefootprint.com/api-reference

Fetches the latest information about a specific onboarding for a user, identified by both user and onboarding external IDs.

```bash
curl https://api.onefootprint.com/users/{fp_id}/onboardings/{id} \
  -u sk_test_xxxxx:
```

--------------------------------

### Get Onboarding Details

Source: https://docs.onefootprint.com/api-reference

Retrieves detailed information about a specific onboarding process, including addresses, business details, names, people, registrations, and watchlist information.

```APIDOC
## GET /businesses/{fp_bid}/onboardings/{onboarding_id}/details

### Description
Retrieves detailed information for a given onboarding process.

### Method
GET

### Endpoint
/businesses/{fp_bid}/onboardings/{onboarding_id}/details

### Parameters
#### Path Parameters
- **fp_bid** (string) - Required - The unique identifier for the business.
- **onboarding_id** (string) - Required - The unique identifier for the onboarding process.

### Request Example
```bash
curl https://api.onefootprint.com/businesses/{fp_bid}/onboardings/{onboarding_id}/details \
  -u sk_test_xxxxx:
```

### Response
#### Success Response (200)
- **addresses** (array) - A list of addresses associated with the onboarding.
- **details** (object) - General details about the business.
- **names** (array) - A list of names associated with the business.
- **people** (array) - A list of people associated with the business.
- **registrations** (array) - A list of business registrations.
- **watchlist** (object) - Watchlist information related to the business.

#### Response Example
```json
{
  "addresses": [
    {
      "address_line1": "Lorem ipsum dolor",
      "address_line2": "Lorem ipsum dolor",
      "city": "Lorem ipsum dolor",
      "cmra": true,
      "deliverable": true,
      "latitude": 1,
      "longitude": 1,
      "postal_code": "Lorem ipsum dolor",
      "property_type": "Lorem ipsum dolor",
      "sources": "Lorem ipsum dolor",
      "state": "Lorem ipsum dolor",
      "submitted": true,
      "verified": true
    }
  ],
  "details": {
    "entity_type": "Lorem ipsum dolor",
    "formation_date": "Lorem ipsum dolor",
    "formation_state": "Lorem ipsum dolor",
    "phone_numbers": [
      {
        "phone": "Lorem ipsum dolor",
        "submitted": true,
        "verified": true
      }
    ],
    "tin": {
      "potential_match": "Lorem ipsum dolor",
      "tin": "Lorem ipsum dolor",
      "verified": true
    },
    "website": {
      "url": "Lorem ipsum dolor",
      "verified": true
    }
  },
  "names": [
    {
      "kind": "Lorem ipsum dolor",
      "name": "Lorem ipsum dolor",
      "sources": "Lorem ipsum dolor",
      "sub_status": "Lorem ipsum dolor",
      "submitted": true,
      "verified": true
    }
  ],
  "people": [
    {
      "association_verified": true,
      "name": "Lorem ipsum dolor",
      "role": "Lorem ipsum dolor",
      "sources": "Lorem ipsum dolor",
      "submitted": true
    }
  ],
  "registrations": [
    {
      "addresses": [
        "Lorem ipsum dolor",
        "Lorem ipsum dolor"
      ],
      "entity_type": "Lorem ipsum dolor",
      "file_number": "Lorem ipsum dolor",
      "jurisdiction": "Lorem ipsum dolor",
      "name": "Lorem ipsum dolor",
      "officers": [
        {
          "name": "Lorem ipsum dolor",
          "roles": "Lorem ipsum dolor"
        }
      ],
      "registered_agent": "Lorem ipsum dolor",
      "registration_date": "Lorem ipsum dolor",
      "source": "Lorem ipsum dolor",
      "state": "Lorem ipsum dolor",
      "status": "Lorem ipsum dolor",
      "sub_status": "Lorem ipsum dolor"
    }
  ],
  "watchlist": {
    "business": [
      {
        "hits": [
          {
            "agency": "Lorem ipsum dolor",
            "agency_abbr": "Lorem ipsum dolor",
            "agency_information_url": "Lorem ipsum dolor",
            "agency_list_url": "Lorem ipsum dolor",
            "entity_addresses": [
              "Lorem ipsum dolor",
              "Lorem ipsum dolor"
            ],
            "entity_aliases": [
              "Lorem ipsum dolor",
              "Lorem ipsum dolor"
            ],
            "entity_name": "Lorem ipsum dolor",
            "list_country": "Lorem ipsum dolor",
            "list_name": "Lorem ipsum dolor",
            "url": "Lorem ipsum dolor"
          }
        ]
      }
    ]
  }
}
```
```

--------------------------------

### Create Onboarding Session with Bootstrap KYB Data

Source: https://docs.onefootprint.com/articles/integrate/bootstrap-data

This example shows how to initiate a KYB (Know Your Business) flow and bootstrap both user and business information by including relevant fields in the `bootstrap_data` object.

```APIDOC
## POST /onboarding/session (KYB)

### Description
Creates an onboarding session token for a KYB flow, including bootstrap data for both user and business information.

### Method
POST

### Endpoint
https://api.onefootprint.com/onboarding/session

### Parameters
#### Request Body
- **bootstrap_data** (object) - Required - An object containing key-value pairs of user and business data to pre-fill.
- **kind** (string) - Required - The type of onboarding flow (e.g., "onboard").
- **key** (string) - Required - The playbook key for the onboarding flow.
- **user_external_id** (string) - Required - A unique identifier for the user.

### Request Example
```json
{
  "bootstrap_data": {
    "id.first_name": "Jane",
    "id.last_name": "Doe",
    "id.dob": "2001-12-30",
    "id.ssn9": "123456789",
    "business.name": "Acme Bank",
    "business.dba": "Acme",
    "business.tin": "12-3456789",
    "business.website": "www.google.com",
    "business.phone_number": "+12025550179",
    "business.address_line1": "123 Main St",
    "business.address_line2": "Apt 123",
    "business.city": "Boston",
    "business.state": "MA",
    "business.zip": "02117",
    "business.country": "US",
    "business.corporation_type": "c_corporation"
  },
  "kind": "onboard",
  "key": "<PLAYBOOK_KEY>",
  "user_external_id": "12345678901"
}
```

### Available Business Data Fields
- **business.name**: Business legal name.
- **business.dba**: Doing Business As name.
- **business.tin**: Tax Identification Number.
- **business.website**: Business website URL.
- **business.phone_number**: Business phone number (E.164 format).
- **business.address_line1**: First line of business street address.
- **business.address_line2**: Second line of business street address.
- **business.city**: Business city.
- **business.state**: Business state (USPS format for US, otherwise any valid UTF-8 string).
- **business.zip**: Business postal code.
- **business.country**: Business country (ISO3166-alpha-2 code).
- **business.corporation_type**: Type of business corporation (e.g., `c_corporation`, `s_corporation`, `llc`, `sole_proprietorship`, `partnership`).
```

--------------------------------

### Create Onboarding Session

Source: https://docs.onefootprint.com/api-reference

Initiates an onboarding session for a user. Optionally includes bootstrap data and specifies the playbook and time-to-live for the token. Use this to start a new user onboarding flow.

```bash
curl -X POST https://api.onefootprint.com/onboarding/session \
  -u sk_test_xxxxx: \
  -d '{
    "bootstrap_data": {
      "id.first_name": "Jane",
      "id.last_name": "Doe"
    },
    "ttl_min": 720,
    "key": "pb_live_fZvYlX3JpanlQ3MAwE45g0",
    "kind": "onboard"
  }'
```

--------------------------------

### JSON Response Example

Source: https://docs.onefootprint.com/articles/vault/proxy

This is an example JSON response structure from which data can be extracted using JSONPath.

```json
1{
2  "data": {
3    "card": {
4      "number": "4242424242424",
5      "expiration": {
6        "month": "04",
7        "year": "25"
8      }
9    },
10    "processor": "amex"
11  }
12}
```

--------------------------------

### Create Headless KYB Onboarding Session

Source: https://docs.onefootprint.com/api-reference

Initiates a KYB onboarding session for a business using a specified playbook. Supports re-onboarding and sandbox fixture results.

```bash
curl -X POST https://api.onefootprint.com/businesses/{fp_bid}/kyb \
  -u sk_test_xxxxx: \
  -d '{
    "allow_reonboard": true,
    "key": "pb_live_fZvYlX3JpanlQ3MAwE45g0"
  }'
```

--------------------------------

### User Duplicate Attributes Response Example

Source: https://docs.onefootprint.com/api-reference

Example JSON response when listing users with duplicate attributes.

```json
[
  {
    "external_id": "0cece047-151f-4ac4-9782-dc27691fd766",
    "fp_id": "fp_id_7p793EF07xKXHqAeg5VGPj",
    "kind": "ssn9",
    "label": "active",
    "tags": [
      "Lorem ipsum dolor",
      "Lorem ipsum dolor"
    ]
  },
  {
    "external_id": "0cece047-151f-4ac4-9782-dc27691fd766",
    "fp_id": "fp_id_7p793EF07xKXHqAeg5VGPj",
    "kind": "ssn9",
    "label": "active",
    "tags": [
      "Lorem ipsum dolor",
      "Lorem ipsum dolor"
    ]
  }
]
```

--------------------------------

### Investment Transactions Response Example

Source: https://docs.onefootprint.com/api-reference

Example JSON response for investment transactions, including transaction details and associated securities.

```json
{
  "investment_transactions": [
    {
      "account_id": "acc_12345678",
      "amount": 1000,
      "date": "2023-05-15",
      "datetime": "2023-05-15T14:30:00Z",
      "description": "BUY 10 AAPL",
      "fees": 4.99,
      "forex_rate": 1,
      "investment_transaction_id": "inv_txn_abcdefgh1234",
      "price": 150.75,
      "quantity": 10,
      "security_id": "sec_aapl",
      "type": "buy"
    },
    {
      "account_id": "acc_12345678",
      "amount": 1000,
      "date": "2023-05-15",
      "datetime": "2023-05-15T14:30:00Z",
      "description": "BUY 10 AAPL",
      "fees": 4.99,
      "forex_rate": 1,
      "investment_transaction_id": "inv_txn_abcdefgh1234",
      "price": 150.75,
      "quantity": 10,
      "security_id": "sec_aapl",
      "type": "buy"
    }
  ],
  "page": 1,
  "securities": [
    {
      "close_date": "2023-05-15",
      "close_price": 150.75,
      "currency": "USD",
      "isin": "US0378331005",
      "name": "Apple Inc.",
      "security_id": "sec_aapl",
      "sedol": 2046251,
      "ticker": "AAPL",
      "type": "equity"
    },
    {
      "close_date": "2023-05-15",
      "close_price": 150.75,
      "currency": "USD",
      "isin": "US0378331005",
      "name": "Apple Inc.",
      "security_id": "sec_aapl",
      "sedol": 2046251,
      "ticker": "AAPL",
      "type": "equity"
    }
  ],
  "size": 25,
  "total": 50
}
```

--------------------------------

### Create Onboarding Session

Source: https://docs.onefootprint.com/api-reference

Initiates an onboarding session for a user, prompting them to onboard onto a specified playbook. The token returned should be passed into the Footprint SDK.

```APIDOC
## POST /onboarding/session

### Description
Creates an onboarding session that prompts the user to onboard onto the specified playbook.

### Method
POST

### Endpoint
/onboarding/session

### Parameters
#### Request Body
- **kind** (string) - Required - Allowed values: `onboard`, `inherit`, `update_login_methods`, `link_bank_account`
- **bootstrap_data** (object) - Optional - Any user or business bootstrap data to pass into the onboarding flow.
- **key** (string) - Required - The playbook key to be used for the onboarding.
- **sandbox_id** (string) - Optional - If using a sandbox playbook, the sandbox ID to use. A sandbox ID will be generated if not provided for a sandbox playbook.
- **ttl_min** (integer) - Optional - Time to live until this token expires, in minutes. Defaults to 12 hours. Must be at least 1 minute, at most 3 days.
- **fp_id** (string) - Required for `inherit`, `update_login_methods`, and `link_bank_account` kinds - The identifier of the user for which the onboarding session should be created.
- **limit_auth_methods** (array of strings) - Optional - Can only be provided when the kind is `update_login_methods`. The set of auth methods allowed to be updated. Defaults to all methods if not provided.
- **config** (object) - Optional - Configure the bank linking widget for the onboarding session.

### Request Example
```json
{
  "bootstrap_data": {
    "id.first_name": "Jane",
    "id.last_name": "Doe"
  },
  "ttl_min": 720,
  "key": "pb_live_fZvYlX3JpanlQ3MAwE45g0",
  "kind": "onboard"
}
```

### Response
#### Success Response (200)
- **expires_at** (string) - The expiration time of the token.
- **link** (string) - A Footprint link embedding the token for the user to complete the flow.
- **token** (string) - A short-lived onboarding session token for the frontend SDK.
```

--------------------------------

### Initialize Onboarding with SDK

Source: https://docs.onefootprint.com/articles/guides/bank-linking

Initialize the Footprint onboarding flow within your web application. Provide an onboarding session token and define callbacks for completion, errors, authentication, cancellation, and closing the flow.

```typescript
import { onboarding } from "@onefootprint/footprint-js";
onboarding.initialize({
  onboardingSessionToken: "obtok_UxM6Vbvk2Rcy1gzcSuXgk3sj3L9I0pAnNH",
  onComplete: (validationToken) => {
    console.log(validationToken);
  },
  onError: (error) => {
    console.log(error);
  },
  onAuth: (validationToken) => {
    console.log(validationToken);
  },
  onCancel: () => {
    console.log("User canceled the flow");
  },
  onClose: () => {
    console.log("User closed the flow");
  },
});
```

--------------------------------

### Response Example for Data Deletion

Source: https://docs.onefootprint.com/api-reference

This is an example of the response received after attempting to delete data from a business vault. It indicates the success or failure for each identifier.

```json
{
  "business.name": true,
  "custom.account_id": false
}
```

--------------------------------

### Vault Proxy Ingress Rule Examples

Source: https://docs.onefootprint.com/articles/vault/proxy

These examples demonstrate various formats for ingress rules, including extracting different card-related fields.

```plaintext
fp_id_tctecBEvGc98V7Vx4MhZU.card.primary.number=$.data.card.number
fp_id_tctecBEvGc98V7Vx4MhZU.card.primary.exp_month=$.data.card.expiration_month
fp_id_tctecBEvGc98V7Vx4MhZU.card.primary.exp_year=$.data.card.expiration_year
fp_id_tctecBEvGc98V7Vx4MhZU.card.primary.cvc=$.data.card.security_code
```

--------------------------------

### Create Onboarding Session with Bootstrap Data

Source: https://docs.onefootprint.com/articles/integrate/bootstrap-data

This example demonstrates how to create an onboarding session token via the API, including bootstrap data for user information. The bootstrap data is securely transmitted and validated before the user begins the onboarding flow.

```APIDOC
## POST /onboarding/session

### Description
Creates an onboarding session token with pre-filled bootstrap data.

### Method
POST

### Endpoint
https://api.onefootprint.com/onboarding/session

### Parameters
#### Request Body
- **bootstrap_data** (object) - Required - An object containing key-value pairs of user data to pre-fill.
- **kind** (string) - Required - The type of onboarding flow (e.g., "onboard").
- **key** (string) - Required - The playbook key for the onboarding flow.
- **user_external_id** (string) - Required - A unique identifier for the user.

### Request Example
```json
{
  "bootstrap_data": {
    "id.email": "jane.doe@acme.com",
    "id.phone_number": "+1 (555) 555-0100",
    "id.first_name": "Jane",
    "id.last_name": "Doe",
    "id.dob": "2000-01-01",
    "id.address_line1": "1 Main St",
    "id.city": "San Francisco",
    "id.state": "CA",
    "id.zip": "11111",
    "id.country": "US",
    "id.ssn9": "123-45-6789"
  },
  "kind": "onboard",
  "key": "<PLAYBOOK_KEY>",
  "user_external_id": "12345678901"
}
```

### Available User Data Fields
- **id.phone_number**: Primary phone number (E.164 format).
- **id.email**: Primary email address.
- **id.first_name**: First name (UTF-8 string <1KB).
- **id.middle_name**: Middle name (UTF-8 string <1KB).
- **id.last_name**: Last name (UTF-8 string <1KB).
- **id.ssn9**: Full SSN (9-digit string, hyphens stripped).
- **id.ssn4**: Last four of the SSN (4-digit string).
- **id.dob**: Date of birth (YYYY-MM-DD).
- **id.address_line1**: First line of street address (UTF-8 string <1KB).
- **id.address_line2**: Second line of street address (UTF-8 string <1KB).
- **id.city**: City of street address (UTF-8 string <1KB).
- **id.state**: State of street address (USPS format for US, UTF-8 string <1KB otherwise).
- **id.zip**: Postal code (alphanumeric with hyphens and spaces).
- **id.country**: Country (ISO3166-alpha-2 code).
- **id.us_legal_status**: US legal status (`citizen`, `permanent_resident`, `visa`).
- **id.nationality**: Nationality (ISO3166-alpha-2 code).
- **id.citizenships**: List of citizenships (ISO3166-alpha-2 codes).
- **id.visa_kind**: Type of US visa (`e1`, `e2`, `e3`, `f1`, `g4`, `h1b`, `l1`, `o1`, `tn1`, `other`).
- **id.visa_expiration_date**: Visa expiration date (YYYY-MM-DD).
```

--------------------------------

### Transaction Sync Response Example

Source: https://docs.onefootprint.com/api-reference

This is an example of the JSON response received after synchronizing bank transactions. It includes details about created, removed, and updated transactions.

```json
{
  "cursor": {
    "next": "abcdefgh1234"
  },
  "has_more": true,
  "transactions": {
    "created": [
      {
        "account_id": "acc_12345678",
        "amount": "42.99",
        "category": "food_and_drink",
        "currency": "USD",
        "date": "2023-02-16",
        "datetime": "2023-05-15T14:30:00Z",
        "description": "Starbucks Coffee",
        "enrichment": {
          "category": {
            "confidence": "95",
            "value": "banking"
          },
          "merchant": {
            "confidence": 95,
            "id": "starbucks",
            "logo": "https://example.com/starbucks.png",
            "name": "Starbucks"
          },
          "processor": {
            "confidence": 95,
            "id": "starbucks",
            "logo": "https://example.com/starbucks.png",
            "name": "Starbucks"
          },
          "subcategory": {
            "confidence": "95",
            "value": "account_fees_and_other_bank_charges"
          }
        },
        "pending": false,
        "raw_description": "POS PURCHASE STARBUCKS STORE",
        "transaction_id": "txn_abcdefgh1234",
        "type": "debit"
      },
      {
        "account_id": "acc_12345678",
        "amount": "42.99",
        "category": "food_and_drink",
        "currency": "USD",
        "date": "2023-02-16",
        "datetime": "2023-05-15T14:30:00Z",
        "description": "Starbucks Coffee",
        "enrichment": {
          "category": {
            "confidence": "95",
            "value": "banking"
          },
          "merchant": {
            "confidence": 95,
            "id": "starbucks",
            "logo": "https://example.com/starbucks.png",
            "name": "Starbucks"
          },
          "processor": {
            "confidence": 95,
            "id": "starbucks",
            "logo": "https://example.com/starbucks.png",
            "name": "Starbucks"
          },
          "subcategory": {
            "confidence": "95",
            "value": "account_fees_and_other_bank_charges"
          }
        },
        "pending": false,
        "raw_description": "POS PURCHASE STARBUCKS STORE",
        "transaction_id": "txn_abcdefgh1234",
        "type": "debit"
      }
    ],
    "removed": [
      "Lorem ipsum dolor",
      "Lorem ipsum dolor"
    ],
    "updated": [
      {
        "account_id": "acc_12345678",
        "amount": "42.99",
        "category": "food_and_drink",
        "currency": "USD",
        "date": "2023-02-16",
        "datetime": "2023-05-15T14:30:00Z",
        "description": "Starbucks Coffee",
        "enrichment": {
          "category": {
            "confidence": "95",
            "value": "banking"
          },
          "merchant": {
            "confidence": 95,
            "id": "starbucks",
            "logo": "https://example.com/starbucks.png",
            "name": "Starbucks"
          },
          "processor": {
            "confidence": 95,
            "id": "starbucks",
            "logo": "https://example.com/starbucks.png",
            "name": "Starbucks"
          },
          "subcategory": {
            "confidence": "95",
            "value": "account_fees_and_other_bank_charges"
          }
        },
        "pending": false,
        "raw_description": "POS PURCHASE STARBUCKS STORE",
        "transaction_id": "txn_abcdefgh1234",
        "type": "debit"
      },
      {
        "account_id": "acc_12345678",
        "amount": "42.99",
        "category": "food_and_drink",
        "currency": "USD",
        "date": "2023-02-16",
        "datetime": "2023-05-15T14:30:00Z",
        "description": "Starbucks Coffee",
        "enrichment": {
          "category": {
            "confidence": "95",
            "value": "banking"
          },
          "merchant": {
            "confidence": 95,
            "id": "starbucks",
            "logo": "https://example.com/starbucks.png",
            "name": "Starbucks"
          },
          "processor": {
            "confidence": 95,
            "id": "starbucks",
            "logo": "https://example.com/starbucks.png",
            "name": "Starbucks"
          },
          "subcategory": {
            "confidence": "95",
            "value": "account_fees_and_other_bank_charges"
          }
        },
        "pending": false,
        "raw_description": "POS PURCHASE STARBUCKS STORE",
        "transaction_id": "txn_abcdefgh1234",
        "type": "debit"
      }
    ]
  }
}
```

--------------------------------

### Initiate User KYC

Source: https://docs.onefootprint.com/api-reference

Use this endpoint to start the KYC process for a user on a specified playbook. It handles onboarding and decision-making based on the playbook's rules. Ensure you provide a valid playbook key.

```bash
curl -X POST https://api.onefootprint.com/users/{fp_id}/kyc \
  -u sk_test_xxxxx: \
  -d '{
    "key": "pb_live_fZvYlX3JpanlQ3MAwE45g0"
  }'
```

--------------------------------

### Example API Response for Validation

Source: https://docs.onefootprint.com/articles/guides/bank-linking

This is an example of the JSON response you might receive after successfully validating a token. It includes user and bank link details.

```json
{
  "user": {
    "fp_id": "fp_id_GSxJr68GAf5jUT3pdL9ndjf7TLkA3GCX",
    "onboarding_id": "ob_SRFT2a1mN7DAWJ0VPXkiqK",
    "playbook_key": "pb_test_VMooXd04EUlnu3AvMYKjMW"
  },
  "bank_link": {
    "link_id": "bank_link_xyz123...xyz321"
  }
  ...
}
```

--------------------------------

### Retrieve Business Onboarding Details

Source: https://docs.onefootprint.com/api-reference

Use this endpoint to fetch detailed information about a specific business onboarding. Ensure you replace placeholders with your actual business ID and onboarding ID. Authentication is required using your API key.

```bash
curl https://api.onefootprint.com/businesses/{fp_bid}/onboardings/{onboarding_id}/details \
  -u sk_test_xxxxx:
```

--------------------------------

### Create Onboarding Session with KYB Bootstrap Data

Source: https://docs.onefootprint.com/articles/integrate/bootstrap-data

Initiate a KYB flow by bootstrapping both user identity and business information. This call includes fields for both user and business details.

```bash
curl -X POST https://api.onefootprint.com/onboarding/session \
  -H 'X-Footprint-Secret-Key: <SECRET_API_KEY>' \
  -d \
  '{
    "bootstrap_data": {
      "id.first_name": "Jane",
      "id.last_name": "Doe",
      "id.dob": "2001-12-30",
      "id.ssn9": "123456789",
      "business.name": "Acme Bank",
      "business.dba": "Acme",
      "business.tin": "12-3456789",
      "business.website": "www.google.com",
      "business.phone_number": "+12025550179",
      "business.address_line1": "123 Main St",
      "business.address_line2": "Apt 123",
      "business.city": "Boston",
      "business.state": "MA",
      "business.zip": "02117",
      "business.country": "US",
      "business.corporation_type": "c_corporation"
    },
    "kind": "onboard",
    "key": "<PLAYBOOK_KEY>",
    "user_external_id": "12345678901"
  }'
```

--------------------------------

### Bank Transactions Response Example

Source: https://docs.onefootprint.com/api-reference

An example of the JSON response structure for bank transactions, including details like account ID, amount, date, and enrichment data.

```json
{
  "page": 1,
  "size": 25,
  "total": 100,
  "transactions": [
    {
      "account_id": "acc_12345678",
      "amount": "42.99",
      "category": "food_and_drink",
      "currency": "USD",
      "date": "2023-02-16",
      "datetime": "2023-05-15T14:30:00Z",
      "description": "Starbucks Coffee",
      "enrichment": {
        "category": {
          "confidence": "95",
          "value": "banking"
        },
        "merchant": {
          "confidence": 95,
          "id": "starbucks",
          "logo": "https://example.com/starbucks.png",
          "name": "Starbucks"
        },
        "processor": {
          "confidence": 95,
          "id": "starbucks",
          "logo": "https://example.com/starbucks.png",
          "name": "Starbucks"
        },
        "subcategory": {
          "confidence": "95",
          "value": "account_fees_and_other_bank_charges"
        }
      },
      "pending": false,
      "raw_description": "POS PURCHASE STARBUCKS STORE",
      "transaction_id": "txn_abcdefgh1234",
      "type": "debit"
    },
    {
      "account_id": "acc_12345678",
      "amount": "42.99",
      "category": "food_and_drink",
      "currency": "USD",
      "date": "2023-02-16",
      "datetime": "2023-05-15T14:30:00Z",
      "description": "Starbucks Coffee",
      "enrichment": {
        "category": {
          "confidence": "95",
          "value": "banking"
        },
        "merchant": {
          "confidence": 95,
          "id": "starbucks",
          "logo": "https://example.com/starbucks.png",
          "name": "Starbucks"
        },
        "processor": {
          "confidence": 95,
          "id": "starbucks",
          "logo": "https://example.com/starbucks.png",
          "name": "Starbucks"
        },
        "subcategory": {
          "confidence": "95",
          "value": "account_fees_and_other_bank_charges"
        }
      },
      "pending": false,
      "raw_description": "POS PURCHASE STARBUCKS STORE",
      "transaction_id": "txn_abcdefgh1234",
      "type": "debit"
    }
  ]
}
```

--------------------------------

### Business Risk Signals Response Example

Source: https://docs.onefootprint.com/api-reference

Example JSON response for business risk signals, detailing description, note, reason code, scopes, severity, and timestamp.

```json
[
  {
    "description": "Address located does not match address input.",
    "note": "Address does not match",
    "reason_code": "address_does_not_match",
    "scopes": [
      "address"
    ],
    "severity": "high",
    "timestamp": "2022-01-04T12:00-07:00"
  },
  {
    "description": "Address located does not match address input.",
    "note": "Address does not match",
    "reason_code": "address_does_not_match",
    "scopes": [
      "address"
    ],
    "severity": "high",
    "timestamp": "2022-01-04T12:00-07:00"
  }
]
```

--------------------------------

### Create Onboarding Session with FP Bid

Source: https://docs.onefootprint.com/articles/integrate/onboarding-sessions

Create an onboarding session for a KYB flow and guarantee resolution to a specific business by providing its Footprint Business ID (fp_bid).

```APIDOC
## POST /onboarding/session with fp_bid

### Description
Initiates a KYB onboarding session that resolves to a specific business identified by its Footprint Business ID.

### Method
POST

### Endpoint
https://api.onefootprint.com/onboarding/session

### Parameters
#### Request Body
- **kind** (string) - Required - The type of onboarding flow (e.g., "onboard").
- **key** (string) - Required - The playbook key for the onboarding flow.
- **fp_id** (string) - Required - The existing Footprint user ID.
- **fp_bid** (string) - Required - The existing Footprint business ID.

### Request Example
```bash
curl -X POST https://api.onefootprint.com/onboarding/session \
  -u sk_test_CXUsbCR8j2kH6e5GeEl8eSBnQTIPCUaKpv: \
  -d '{
    "kind": "onboard",
    "key": "pb_live_qBV2iO3nQI5moqo5GJlFhI",
    "fp_id": "fp_id_K0q6Eh6Rr3WOOfFBLPiHsr",
    "fp_bid": "fp_bid_fr7JHcV3hIzC7KbqTAsD3n"
  }'
```
```
Tokens:
Raw