Synapse Developer Hub

Welcome to the Synapse Developer Hub. Here you will find comprehensive guides and documentation to help you start working with the Synapse API as quickly as possible. If you need any assistance, we are always here to help!

Support

Recent Posts

Archive

Create User

Before you do anything else, create a User. The user object can be created with minimal parameters (such as login, password and scope), or you can create the user object with more information (including the KYC documents outlined in your Spec Sheet).

Important Values to StoreUpon successful creation of a user, the user is assigned a unique object ID (_id) and a refresh token (refresh_token). Please store these to reference the user and generate an OAuth token.

Asynchronous User Verification:User verification is asynchronous. If multiple documents are submitted, it will take longer to verify all of them. Check the appropriate document status to determine whether the required sub-documents are accepted. Check the user's overall permission to show whether all KYC requirements were met.

Testing in SandboxRefer to our Sandbox Test Values to test different responses, including address validation and virtual/physical/social document verification.

Idempotent Requests

Indempotent Requests:Idempotency allows you to safely retry requests without accidentally performing the same operation twice. For example, if a request to create a user fails due to a network connection error, you can retry the request with the same idempotency key to guarantee that only a user object is created.

To perform an idempotent request, attach a unique key to any POST request made to the API via the X-SP-IDEMPOTENCY-KEY: <key> header.

Idempotency keys expire after 24 hours.

Subscribe to Webhooks

Please subscribe to user webhooks to monitor permissions and statuses of users and their documents.