Refresh Token - Command by ClearGrid AI

Use the refresh token obtained from the Lender Login endpoint to obtain a new access token without re-authenticating with email and password. This enables seamless token rotation for long-running integrations.

Request

Endpoint

POST {{base_url}}/admin/auth/{{lender}}/refresh-token

Environment	Base URL
Production	`https://v3-api.cleargrid.ai/`
Staging	`https://stage-v3-api.cleargrid.ai/`

Body Parameters

refreshToken

string

required

The refresh token obtained from the Lender Login response.

Example Request

curl -X POST https://v3-api.cleargrid.ai/admin/auth/{your_lender_id}/refresh-token \
  -H "Content-Type: application/json" \
  -d '{
    "refreshToken": "<refresh_token>"
  }'

Response

200 — Success
401 — Invalid Token
400 — Bad Request

{
  "token": "<access_token>"
}

Field	Type	Description
`token`	string	The new access token. Use this as a Bearer token in the `Authorization` header for all subsequent API requests.

{
  "code": 401,
  "message": "Token Type is not refresh",
  "body": null
}

This error occurs when you pass an access token instead of a refresh token. Make sure to use the refreshToken value from the original login response.

{
  "type": "about:blank",
  "title": "Bad Request",
  "status": 400,
  "detail": "Failed to read request",
  "instance": "/api/v1/auth/{lender}/refresh-token",
  "properties": null
}

The request body is malformed or missing required fields. Ensure the JSON body includes a valid refreshToken field.

Token Refresh Flow

Implement automatic token refresh in your integration. When any API call returns a 401 response, call the refresh token endpoint and retry the failed request with the new access token.

Path Parameters

lender

string

required

Your lender subdomain identifier.

Body

application/json

refreshToken

string

required

The refresh token obtained from the Lender Login response.

Example:

"eyJhbGciOiJIUzUxMiJ9..."

Response

Token refreshed successfully

token

string

New access token. Use as a Bearer token in the Authorization header.

​Request

​Endpoint

​Body Parameters

​Example Request

​Response

​Token Refresh Flow

Path Parameters

Body

Response

Request

Endpoint

Body Parameters

Example Request

Response

Token Refresh Flow