Get Access Token

Generate a short-lived access token for a registered user so your application can redirect them into Jodo-hosted flows.

Endpoint

GET /api/v1/integrations/erp/users/:registration_id/access_token

Request

curl -X GET 'https://[base_url]/api/v1/integrations/erp/users/:registration_id/access_token' \
  --header 'Authorization: Basic <token>' \
  --header 'Content-Type: application/json'

Response

{
  "status": "success",
  "data": {
    "access_token": "SGFwcGkgY29kaW5nISBeX14=",
    "expires_at": "2022-02-29T10:05:45Z"
  }
}

Response Data

Field	Type	Description
data.access_token	string	Access token used for Jodo redirect.
data.expires_at	datetime	Expiry time for the token.

Redirecting to Jodo

Use the access token in the Jodo login redirect URL:

https://[base_url]/consumer/login-redirect?access_token=<access_token>

Optional query parameters:

Query Parameter	Description
access_token	Required access token.
jodo_student_id	Jodo student ID to open a student-specific flow.
product_type	Product to open. Possible values: flex, pay, cred. Requires jodo_student_id.
callback_url	URL where the user should return after checkout.
create_application	Set to true to create a new loan application when applicable.

Errors

• User not found.