Feel free to reach techsupport@surepass.io for any technical support or guidance.
Refresh Data
Production
https://kyc-api.surepass.app
Production
https://kyc-api.surepass.app
POST
https://kyc-api.surepass.app
Account Aggregator V2 - Refresh Data
Description
Key Benefits
Use Cases
Fintech & Banking
Wealth Management
Insurance & Risk
Technical Implementation
Authentication
All API requests require authentication using a JWT Bearer token. Authentication follows these steps:Obtain API Credentials: Register with Surepass to receive your API key. Generate JWT Token: Use your API key to generate a JWT token. Include in Requests: Add the token to the Different authentication tokens are used for sandbox and production environments: Sandbox: Production:
1.
2.
3.
Authorization header as Bearer TOKEN.https://sandbox.surepass.apphttps://kyc-api.surepass.appRequest Parameters
Request Headers
| Header | Required | Description |
|---|---|---|
| Authorization | Yes | Bearer JWT token for API authentication |
| Content-Type | Yes | Must be set to application/json |
Request Body
| Parameter | Type | Required | Description |
|---|---|---|---|
| client_id | String | Yes | Unique identifier for the Account Aggregator V2 client session |
Example Request
{
"client_id": "account_aggregator_v2_oOxRfypvwDqMjti"
}Process Response
Response Parameters
| Parameter | Type | Description |
|---|---|---|
| data | Object | Contains the response data with request tracking information |
| data.request_id | String | Unique identifier for tracking the refresh data request |
| status_code | Number | HTTP status code indicating the result of the request |
| message_code | String | Internal status code for the operation |
| message | String | Human-readable message describing the operation result |
| success | Boolean | Indicates whether the request was processed successfully |
Example Successful Response
{
"data": {
"request_id": "account_aggregator_v2_ojmzgkXAqwzTk"
},
"status_code": 200,
"message_code": "success",
"message": "Success",
"success": true
}Possible Error Responses
Invalid Client ID
Authentication Error
{
"data": null,
"status_code": 400,
"message_code": "invalid_client_id",
"message": "Invalid or expired client ID provided",
"success": false
}Integration Best Practices
Security Recommendations
User Experience Guidelines
Code Samples
cURL
Python
Node.js
Related APIs
Account Aggregator V2 Data Retrieval: Fetch the refreshed financial data once the refresh process is complete
Account Aggregator V2 Session Management: Manage client sessions and connection status
Compliance and Legal Considerations
Request
Body Params application/json
Responses
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://kyc-api.surepass.app/api/v1/account-aggregator-v2/refresh-data' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
"client_id": "account_aggregator_v2_oOxRfypvwDqMjti"
}'Response Response Example
{
"data": {
"request_id": "account_aggregator_v2_oOxRfypvwDqMjti"
},
"status_code": 200,
"message_code": "success",
"message": "Success",
"success": true
}