Skip to main content
POST
Register a user

Authorizations

Authorization
string
header
required

Username = your client id. Password = your client secret.

So the base64-encoded username:password described below is client_id:client_secret:

Most HTTP clients build that header for you:

Both values come from Developers โ†’ Apps โ†’ your app. The secret is shown once at creation and is prefixed oac_.

Body

application/json
email
string<email>
required

The end user's email address. Synci emails their sign-in codes here, so it must be an address they can read. Must not already belong to a Synci account.

Maximum string length: 255
external_user_id
string | null

Your own identifier for this user, echoed back on every response so you can correlate without storing Synci ids. Unique within your app.

Maximum string length: 255
name
string | null

Display name. Derived from the email address when omitted.

Maximum string length: 255
connection_limit
integer | null

How many financial connections this user may create: bank, brokerage and crypto-exchange alike. Defaults to your app's limit.

Required range: 0 <= x <= 20

Response

The response is of type object.