Skip to main content
POST
/
accounts
/
customers
Create a new customer or retrieve a customer by its external id
curl --request POST \
  --url https://api-sb.meld.io/accounts/customers \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "dateOfBirth": "<string>",
  "email": "jsmith@example.com",
  "externalId": "<string>",
  "name": {
    "firstName": "<string>",
    "lastName": "<string>"
  },
  "phone": "<string>"
}
'
{
  "accountId": "<string>",
  "addresses": [
    {
      "addressDetails": {
        "city": "<string>",
        "country": "<string>",
        "lineOne": "<string>",
        "lineTwo": "<string>",
        "postalCode": "<string>",
        "region": "<string>"
      },
      "customerId": "<string>",
      "id": "<string>"
    }
  ],
  "dateOfBirth": "<string>",
  "email": "<string>",
  "externalId": "<string>",
  "id": "<string>",
  "key": "<string>",
  "name": {
    "firstName": "<string>",
    "lastName": "<string>"
  },
  "phone": "<string>",
  "previouslyUsedOnramps": [
    {
      "previouslyUsed": "2023-11-07T05:31:56Z"
    }
  ],
  "serviceProviderCustomers": [
    {
      "createdAt": "2023-11-07T05:31:56Z",
      "customerId": "<string>",
      "deletedAt": "2023-11-07T05:31:56Z",
      "id": "<string>",
      "kyc": {
        "additionalInfo": {},
        "onboardingMethod": {
          "kycProvider": "<string>",
          "onboardingType": "<string>"
        },
        "updatedAt": "2023-11-07T05:31:56Z"
      },
      "serviceProviderAccessProfileId": "<string>",
      "serviceProviderDetails": {
        "type": "<string>",
        "customerType": "<string>"
      },
      "status": "<string>",
      "wallets": [
        "<string>"
      ]
    }
  ]
}

Authorizations

Authorization
string
header
default:BASIC <Meld API Key>
required

Body

application/json
dateOfBirth
string

Customer's date of birth in ISO format (yyyy-MM-dd)

Pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])$
email
string<email>

Customer's email

externalId
string

Customer's external id

name
object

Customer's name

phone
string

Customer's phone number

type
enum<string>

Customer type

Available options:
INDIVIDUAL,
BUSINESS

Response

Customer is returned

accountId
string

The unique identifier of your account with Meld. This id will be the same for all calls to Meld endpoints made from this account.

addresses
object[]

List of customer addresses

dateOfBirth
string

Customer's date of birth in ISO format (yyyy-MM-dd)

email
string

Customer email

externalId
string

Externally assigned id for the customer

id
string

Unique identifier for this customer

key
string

When this customer is part of a paginated list, this key represents its position in the list.

name
object

Customer name

phone
string

Customer phone

previouslyUsedOnramps
object[]

Onramps the customer has successfully transacted on, with the timestamp of the most recent successful transaction for each. Empty if the customer has no prior successful onramp transactions.

serviceProviderCustomers
object[]

List of customers created with service providers.

status
enum<string>

Customer status

Available options:
ACTIVE,
INACTIVE
type
enum<string>

Customer type

Available options:
INDIVIDUAL,
BUSINESS