Skip to main content
POST
/
v1
/
oauth
/
token
Get an Access Token
curl --request POST \
  --url https://api.sandbox.lead.bank/v1/oauth/token \
  --header 'Content-Type: application/json' \
  --data '
{
  "grant_type": "client_credentials",
  "client_id": "<client_id>",
  "client_secret": "<client_secret>",
  "scope": "ach/read"
}
'
{
  "access_token": "AN_ACCESS_TOKEN",
  "token_type": "Bearer",
  "scope": "ach/read account_number/read",
  "expires_in": 86400
}

Body

application/json
​
grant_type
enum<string>
required

The type of access token you want to request.

Available options:
client_credentials
​
client_id
string
required

Your client ID.

Example:

"<client_id>"

​
client_secret
string
required

Your client secret.

Example:

"<client_secret>"

​
scope
enum<string>

A space delimited list of scopes your access token should be provisioned to allow.

Available options:
account_number/read,
account_number/read_write,
ach/read,
ach/read_write,
wire/read,
wire/read_write,
instant_payment/read,
instant_payment/read_write,
event/read,
internal_transfer/read,
internal_transfer/read_write,
lending/read,
lending/read_write,
entity/read,
entity/read_write,
funding/read,
funding/read_write,
subledger_balance/read,
subledger_balance/read_write
Example:

"ach/read"

Response

Successful token exchange

​
access_token
string

A Base64 access token.

Example:

"AN_ACCESS_TOKEN"

​
token_type
string

The token type.

Example:

"Bearer"

​
scope
string

A space delimited list of scopes your access token is provisioned for.

Example:

"ach/read account_number/read"

​
expires_in
integer

The number of seconds the access token will expire in.

Example:

86400