Introduction

The API Reference describes our RESTful APIs endpoints. Each endpoint description provides the information you’ll need to form requests and handle responses: parameters for request path, request body, and responses. You’ll also find example requests and responses.

📘

Request Validation

Synctera will not correct your requests other than for potential abuse / sanitization. You will need to validate and clean your input to ensure that your customer information is usable for features like KYC or mailing physical cards.

👍

API Preview

Features that may be useful to integrators are accessible as early as possible on the Synctera platform. We have a few stages of API release: alpha, beta, stable. Any endpoint that is not tagged as alpha or beta is stable.

alpha - Alpha APIs are previews of APIs in development with plans to hit stable release within 3 months. Alpha APIs are meant to collaborate with early partners to refine functionality.

Endpoints will only be available in sandbox and may return a 501 not implemented or a stubbed mock response. Please reach out to your point of contact at Synctera if you'd like to provide feedback or collaborate with us on development.

beta - Beta APIs are meant to enable testing a feature in production but not for use with real end customers. Beta APIs are fully functional, but may experience breaking changes before final stable release. Should Synctera need to make any breaking changes, Beta partners will be notified and given ample time to update. Beta API features may also be unstable. Please reach out to your point of contact at Synctera if you'd like to provide feedback or request additional details on planned updates.

stable - Stable APIs are ready for end customers in production.

deprecated - APIs marked as deprecated will no longer be supported in the next version of the API.