Authentication

You will need the access token as the header of almost all the requests made via our API. To receive it, you will need to make a credential request using the information we sent you regarding your credentials. The generated token will be valid for 24 hours.

You must replace YOUR_JWT_TOKEN with the JWT from sign-in. Connect from the header to call live sandbox or production APIs from this site.

This endpoint has a rate limit of 3 requests per 30 seconds, so ensure to re-use the generated token whenever possible.

Authorization: Bearer YOUR_JWT_TOKEN

To authenticate, use this code:

curl -X POST "{{API_BASE_URL}}/sign_in" \
  -H "Content-Type: application/json" \
  -d '{
    "user": {
      "username": "email registered",
      "password": "password"
    }
  }'

Make sure to replace username and password with your API keys given on the onboarding process.

{
  "jwt": "eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9....",
  "name": "name registered",
  "username": "email registered"
}

POST/sign_in

Body Parameters

Parameter	Description	Type	Required
`user`	An object containing all the required values	object	true
`username`	API username	string	true
`password`	API password	string	true

Demonstration

Connect from the header (or this form) to authenticate. The session stays in memory, sample curl hosts follow the selected environment, and you can load pay-in bank accounts. See Real Bank Accounts for more details.

Authentication

Was this helpful?

Sign-in

Body Parameters

Demonstration