Post Customer Information

curl --request POST \
  --url https://api.sandbox.sardine.ai/v1/customers \
  --header 'Content-Type: application/json' \
  --data '
{
  "flow": "<string>",
  "sessionKey": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "customer": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "taxId": "<string>",
    "firstName": "<string>",
    "lastName": "<string>",
    "dateOfBirth": "2023-12-25",
    "address": {
      "street1": "<string>",
      "city": "<string>",
      "regionCode": "<string>",
      "postalCode": "<string>",
      "countryCode": "<string>"
    },
    "transaction": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "createdAtMillis": 123,
      "amount": 123,
      "itemCategory": "<string>",
      "actionType": "buy",
      "currencyCode": "<string>",
      "paymentMethod": {
        "type": "crypto",
        "bank": {
          "accountNumber": "<string>",
          "routingNumber": "<string>",
          "accountType": "checking",
          "balance": 123,
          "balanceCurrencyCode": "<string>"
        }
      }
    },
    "emailAddress": "[email protected]",
    "isEmailVerified": true,
    "phone": "<string>",
    "isPhoneVerified": true,
    "createdAtMills": 123,
    "personalInfo": [
      {
        "source": "id_verification",
        "firstName": "<string>",
        "middleName": "<string>",
        "lastName": "<string>",
        "address": {
          "street1": "<string>",
          "street2": "<string>",
          "city": "<string>",
          "regionCode": "<string>",
          "postalCode": "<string>",
          "countryCode": "<string>",
          "company": "<string>"
        },
        "dateOfBirth": "<string>"
      }
    ]
  }
}
'

{
  "sessionKey": "<string>",
  "level": "low",
  "status": "Success",
  "customer": {
    "score": 123,
    "level": "low",
    "signals": [
      {
        "key": "<string>",
        "value": "<string>"
      }
    ]
  },
  "transaction": {
    "level": "low",
    "amlLevel": "low",
    "indemnification": {
      "decision": "approved",
      "instantLimit": 123,
      "holdAmount": 123,
      "verificationCode": "<string>",
      "holdTime": "<string>"
    }
  }
}

POST

customers

curl --request POST \
  --url https://api.sandbox.sardine.ai/v1/customers \
  --header 'Content-Type: application/json' \
  --data '
{
  "flow": "<string>",
  "sessionKey": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "customer": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "taxId": "<string>",
    "firstName": "<string>",
    "lastName": "<string>",
    "dateOfBirth": "2023-12-25",
    "address": {
      "street1": "<string>",
      "city": "<string>",
      "regionCode": "<string>",
      "postalCode": "<string>",
      "countryCode": "<string>"
    },
    "transaction": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "createdAtMillis": 123,
      "amount": 123,
      "itemCategory": "<string>",
      "actionType": "buy",
      "currencyCode": "<string>",
      "paymentMethod": {
        "type": "crypto",
        "bank": {
          "accountNumber": "<string>",
          "routingNumber": "<string>",
          "accountType": "checking",
          "balance": 123,
          "balanceCurrencyCode": "<string>"
        }
      }
    },
    "emailAddress": "[email protected]",
    "isEmailVerified": true,
    "phone": "<string>",
    "isPhoneVerified": true,
    "createdAtMills": 123,
    "personalInfo": [
      {
        "source": "id_verification",
        "firstName": "<string>",
        "middleName": "<string>",
        "lastName": "<string>",
        "address": {
          "street1": "<string>",
          "street2": "<string>",
          "city": "<string>",
          "regionCode": "<string>",
          "postalCode": "<string>",
          "countryCode": "<string>",
          "company": "<string>"
        },
        "dateOfBirth": "<string>"
      }
    ]
  }
}
'

{
  "sessionKey": "<string>",
  "level": "low",
  "status": "Success",
  "customer": {
    "score": 123,
    "level": "low",
    "signals": [
      {
        "key": "<string>",
        "value": "<string>"
      }
    ]
  },
  "transaction": {
    "level": "low",
    "amlLevel": "low",
    "indemnification": {
      "decision": "approved",
      "instantLimit": 123,
      "holdAmount": 123,
      "verificationCode": "<string>",
      "holdTime": "<string>"
    }
  }
}

Body

application/json

flow

string

required

Merchant defined string that defines the flow the user is in

Minimum string length: 1

sessionKey

string<uuid>

required

uuid that identifies the given customer session

Minimum string length: 1

customer

object

required

Show child attributes

customer.id

string<uuid>

required

User ID hash. Please use the same value as passed to device intelligence SDK

Minimum string length: 1

customer.taxId

string

required

SSN or equivalent

Minimum string length: 1

customer.firstName

string

required

First name of customer

Minimum string length: 1

customer.lastName

string

required

Last name of customer

Minimum string length: 1

customer.dateOfBirth

string<date>

required

Date of birth in YYYY-MM-DD

Minimum string length: 1

customer.address

object

required

Show child attributes

customer.address.street1

string

required

Street name

Minimum string length: 1

customer.address.city

string

required

City name

Minimum string length: 1

customer.address.regionCode

string

required

2 digit State or province code

Minimum string length: 1

customer.address.postalCode

string

required

Postal or Zip code

Minimum string length: 1

customer.address.countryCode

string

required

2 digit Country code

Minimum string length: 1

customer.transaction

object

required

Show child attributes

customer.transaction.id

string<uuid>

required

ID to be associated with transaction

Minimum string length: 1

customer.transaction.createdAtMillis

number

required

Time of transaction in UNIX time

customer.transaction.amount

number

required

Transaction amount

customer.transaction.itemCategory

string

required

Main item category in cart. e.g. crypto asset(ETH, BTC), gift card, alcohol, generic

Minimum string length: 1

customer.transaction.actionType

enum<string>

required

Indicates the type of transaction. If you need other action types to be supported, please reach out to the Sardine team.

Available options:

buy,

sell,

deposit,

exchange,

withdraw,

refund,

payment,

topup,

transfer

Minimum string length: 1

customer.transaction.currencyCode

string

required

3-digit ISO 4217currency code

Minimum string length: 1

customer.transaction.paymentMethod

object

required

Show child attributes

customer.transaction.paymentMethod.type

enum<string>

required

Available options:

crypto

Minimum string length: 1

customer.transaction.paymentMethod.bank

object

required

Show child attributes

customer.transaction.paymentMethod.bank.accountNumber

string

required

Account number of banka account

Minimum string length: 1

customer.transaction.paymentMethod.bank.routingNumber

string

required

Routing number of bank account

Minimum string length: 1

customer.transaction.paymentMethod.bank.accountType

enum<string>

required

Type of account

Available options:

checking,

savings,

other

Minimum string length: 1

customer.transaction.paymentMethod.bank.balance

number

required

Last known bank balance in minor units like cents

customer.transaction.paymentMethod.bank.balanceCurrencyCode

string

required

3 digit currency code

Minimum string length: 1

customer.emailAddress

string<email>

required

Email address of customer

Minimum string length: 1

customer.isEmailVerified

boolean

required

Set to true if email has been verified

customer.phone

string

required

Phone number including country

Minimum string length: 1

customer.isPhoneVerified

boolean

required

Set to true if phone has been verified via a one time code

customer.createdAtMills

integer

This 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

customer.personalInfo

object[]

Show child attributes

customer.personalInfo.source

enum<string>

required

Source of personal information obtained via external third-party (non-Sardine) for verification. Discuss with Sardine before using

Available options:

id_verification,

bank_verification,

phone_verification

customer.personalInfo.firstName

string

First name

customer.personalInfo.middleName

string

Middle name

customer.personalInfo.lastName

string

Last name

customer.personalInfo.address

object

Show child attributes

customer.personalInfo.address.street1

string

Street

customer.personalInfo.address.street2

string

customer.personalInfo.address.city

string

customer.personalInfo.address.regionCode

string

customer.personalInfo.address.postalCode

string

customer.personalInfo.address.countryCode

string

customer.personalInfo.address.company

string

customer.personalInfo.dateOfBirth

string

Response

200 - application/json

sessionKey

string

Minimum string length: 1

level

enum<string>

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.

Available options:

low,

medium,

high,

very_high

Minimum string length: 1

status

enum<string>

Available options:

Success,

Failure

Minimum string length: 1

customer

object

Show child attributes

customer.score

number

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.

customer.level

enum<string>

This field is based on the signals sent in the response.

Available options:

low,

medium,

high,

very_high

Minimum string length: 1

customer.signals

object[]

See https://docs.sardine.ai/api/reference/operation/v1-customers/

Minimum array length: 1

Show child attributes

customer.signals.key

string

Minimum string length: 1

customer.signals.value

string

Minimum string length: 1

transaction

object

Show child attributes

transaction.level

enum<string>

transaction risk level

Available options:

low,

medium,

high

Minimum string length: 1

transaction.amlLevel

enum<string>

aml risk level

Available options:

low,

medium,

high

Minimum string length: 1

transaction.indemnification

object

Show child attributes

transaction.indemnification.decision

enum<string>

Available options:

approved,

conditionally_approved,

rejected,

unknown

Minimum string length: 1

transaction.indemnification.instantLimit

number

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.

transaction.indemnification.holdAmount

number

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.

transaction.indemnification.verificationCode

string

Minimum string length: 1

transaction.indemnification.holdTime

string<time>

UNIX timestamp that represents time until you which should hold part of fund

Get Customers Get KYC Widget URL

⌘I

User Onboarding

Quote

Coverage

Payment Method

Order

Support

Order Execution

Post Customer Information

Body

Response