Sync documents and customers

get

https://api.open-finance.ai/integrations/{integrationId}/changes

A change feed of the integration's documents and customers, for keeping your own copy in sync. Call without cursor to start: it first delivers every record as added (documents, then customers), then the changes since. Keep calling with nextCursor while hasMore is true; later, call again with the last nextCursor for new changes. Each change is delivered once per cycle; added and modified carry the full current record.

Restart without a cursor on 410 CURSOR_EXPIRED (the changes since the cursor are no longer kept) and on 409 CHANGES_RESTART_REQUIRED (the feed was reset).

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Responses

401

Missing or invalid access token (answered by the API gateway, without the error envelope).

Language

Credentials

OAuth2

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Response

400The request is invalid. type: VALIDATION_FAILED, CURSOR_INVALID.

403Refused. type: INSUFFICIENT_SCOPE, FORBIDDEN, IP_NOT_ALLOWED, NOT_AVAILABLE_ON_SURFACE, FORBIDDEN_BY_POLICY, USER_ID_REQUIRED, UPGRADE_REQUIRED, ENTITLEMENT_NOT_PROVISIONED, NOT_ENTITLED.

404Not found. type: NOT_FOUND, INTEGRATION_NOT_FOUND. A malformed id in the path is also NOT_FOUND.

409Conflict. type: ACCOUNT_TERMINATION_PENDING, CHANGES_RESTART_REQUIRED.

410Gone. type: CURSOR_EXPIRED.

429Too many requests. type: RATE_LIMITED. At most 600 requests per minute per API client (all user ids of the key together); wait as Retry-After says.

500Internal error. type: INTERNAL.

503Temporarily unavailable. type: TEMPORARILY_UNAVAILABLE, CONNECTOR_UNAVAILABLE.