Private API Reference

Plaid Processor Tokens

A Plaid Processor Token grants Increase access to an external bank account’s balance and transaction data through Plaid. Increase uses this data when underwriting Loan Applications.

Events

Your application can listen to webhooks about this resource. All of the events about Plaid Processor Tokens will have the category "plaid_processor_token.created" .

The Plaid Processor Token object

{
  "created_at": "2020-01-31T23:59:59Z",
  "id": "plaid_processor_token_u8go17ptm6tnxi70hwiz",
  "idempotency_key": null,
  "type": "plaid_processor_token"
}

Attributes

created_at

string

The ISO 8601 date and time at which the Plaid Processor Token was created.

string

The Plaid Processor Token identifier.

idempotency_key

string

Nullable

The idempotency key you chose for this object. This value is unique across Increase and is used to ensure that a request is only processed once. Learn more about idempotency.

type

string

A constant representing the object’s type. For this resource it will always be plaid_processor_token.

List Plaid Processor Tokens

curl \
  --url "${INCREASE_URL}/plaid_processor_tokens" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}"

Returns a list response :

{
  "data": [
    { /* Plaid Processor Token object */ },
    { /* Plaid Processor Token object */ }
    /* ... */
  ],
  "next_cursor": "v57w5d",
}

Parameters

idempotency_key

string

Filter records to the one with the specified idempotency_key you chose for that object. This value is unique across Increase and is used to ensure that a request is only processed once. Learn more about idempotency.

Between 1 and 200 characters

More parameters

Create a Plaid Processor Token

curl -X "POST" \
  --url "${INCREASE_URL}/plaid_processor_tokens" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}" \
  -H "Content-Type: application/json" \
  -d $'{
    "processor_token": "processor-production-0asd1-a92nc"
  }'

Parameters

processor_token

string

Required

The processor token generated by Plaid for sharing the external bank account with Increase.

Between 1 and 200 characters

Retrieve a Plaid Processor Token

curl \
  --url "${INCREASE_URL}/plaid_processor_tokens/plaid_processor_token_u8go17ptm6tnxi70hwiz" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}"

Parameters

plaid_processor_token_id

string

Required

The identifier of the Plaid Processor Token.

More about Plaid Processor Tokens.