SpareSpare Docs
GuidesAPI Reference

Sync

Start bulk account data sync jobs and poll their status.

Once a consent is authorized, sync queues selective slices of account data (accounts, balances, transactions, statements, and related objects). Poll the job until each requested slice completes.

POST
/data/sync
Authorization
Header

Regulatory jurisdiction the request routes to (e.g. `UAE`, `KSA`, `MAIN`). Match it to the market you're integrating.

Query

UUID of the consent (returned when the consent was created).

Body
*object
object
object
object

Request Body

application/json

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/data/sync?consentId=string" \  -H "x-tenant: UAE" \  -H "Content-Type: application/json" \  -d '{}'
{  "data": {    "jobId": "string"  }}
{  "code": "string",  "details": {},  "message": "string"}
{  "code": "string",  "details": {},  "message": "string"}
{  "code": "string",  "details": {},  "message": "string"}
{  "code": "string",  "details": {},  "message": "string"}
{  "code": "string",  "details": {},  "message": "string"}
{  "code": "string",  "details": {},  "message": "string"}
{  "code": "string",  "details": {},  "message": "string"}
{  "code": "not_found",  "details": {},  "message": "string"}
GET
/data/sync/{jobId}
Authorization
Path
Header

Regulatory jurisdiction the request routes to (e.g. `UAE`, `KSA`, `MAIN`). Match it to the market you're integrating.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/data/sync/string" \  -H "x-tenant: UAE"
{  "data": {    "account": "string",    "balance": "string",    "beneficiary": "string",    "directDebit": "string",    "jobId": "string",    "parties": "string",    "product": "string",    "schedulePayment": "string",    "standingOrder": "string",    "statement": "string",    "transaction": "string"  }}
{  "code": "string",  "details": {},  "message": "string"}
{  "code": "string",  "details": {},  "message": "string"}
{  "code": "string",  "details": {},  "message": "string"}
{  "code": "string",  "details": {},  "message": "string"}
{  "code": "string",  "details": {},  "message": "string"}
{  "code": "string",  "details": {},  "message": "string"}
{  "code": "string",  "details": {},  "message": "string"}
{  "code": "not_found",  "details": {},  "message": "string"}