API Reference
- POSTGet Client Token
- GETGet Trades
- POSTCreate Trade
- GETGet Quote
- POSTSend Identity information
- POSTAccept Identity documents
- GETGet Supported Tokens
- GETGet Enabled Tokens
- GETGet Payment Method information
- GETGet Order(s)
- GETGet Bank Account
- GETFetch KYC
- GETGet Customers
- POSTPost Customer Information
- POSTSend Bank Information
- GETGet Geocoverage
- GETGet Fiat Currencies
Post Customer Information
Send User information to Sardine to store theie information and create a risk profile
Body
City name
12 digit Country code
1Postal or Zip code
12 digit State or province code
1Street name
1Date of birth in YYYY-MM-DD
1Email address of customer
1First name of customer
1User ID hash. Please use the same value as passed to device intelligence SDK
1Set to true if email has been verified
Set to true if phone has been verified via a one time code
Last name of customer
1Phone number including country
1SSN or equivalent
1Indicates the type of transaction. If you need other action types to be supported, please reach out to the Sardine team.
buy, sell, deposit, exchange, withdraw, refund, payment, topup, transfer Transaction amount
Time of transaction in UNIX time
3-digit ISO 4217currency code
1ID to be associated with transaction
1Main item category in cart. e.g. crypto asset(ETH, BTC), gift card, alcohol, generic
1Account number of banka account
1Type of account
checking, savings, other Last known bank balance in minor units like cents
3 digit currency code
1Routing number of bank account
1"crypto"1This is time the customer was onboarded/created in your system. Please pass it as Unix timestamp in milliseconds. e.g. 1622057169587 for Wed May 22021 19:26:09
Source of personal information obtained via external third-party (non-Sardine) for verification. Discuss with Sardine before using
id_verification, bank_verification, phone_verification Street
First name
Last name
Middle name
Merchant defined string that defines the flow the user is in
1uuid that identifies the given customer session
1Response
This field is based on the signals sent in the response.
low, medium, high, very_high ML Risk Score for the current customer session. The ML model used to predict the score is trained on velocity and aggregation features, phone, email, bank, tax, card, IP, location, device and behavior intelligence signals. The score can be used once feedback for historical transactions has been provided.
This is the ONLY field that a merchant needs to use to make decision on fraud. This field is set by our rules and the main rule is the rule using our "customer score" model.
low, medium, high, very_high 1Success, Failure aml risk level
low, medium, high approved, conditionally_approved, rejected, unknown This is the remaining amount in cents that is available after the hold time is over. The hold time + instantLimit is the total deposit amount.
UNIX timestamp that represents time until you which should hold part of fund
This is the withdrawal amount in cents that is immediately available to the end-user. The remaining hold amount should be kept on hold on your side until the time specified by holdTime parameter below.
1transaction risk level
low, medium, high