Skip to main content
POST
/
admin
/
auth
/
{lender}
/
refresh-token
Refresh access token
curl --request POST \
  --url https://v3-api.cleargrid.ai/admin/auth/{lender}/refresh-token \
  --header 'Content-Type: application/json' \
  --data '
{
  "refreshToken": "eyJhbGciOiJIUzUxMiJ9..."
}
'
{
  "token": "<new_access_token>"
}
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
EnvironmentBase URL
Productionhttps://v3-api.cleargrid.ai/
Staginghttps://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

{
  "token": "<access_token>"
}
FieldTypeDescription
tokenstringThe new access token. Use this as a Bearer token in the Authorization header for all subsequent API requests.

​
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.