Create a new User.

post https://example.com/users

A POST request sent to create a User and Wallet. This endpoint is common to both prepaid and debit programs.

Responses

Response body

object

string

A User identifier. Begins with 'usr-' followed by a v4 UUID

status

string

The different statuses for a user:

unverified - Upon creation, a user begins with this status, until kyc has been performed successfully.
active - After a successfull kyc verification, the user get this status, enabling regular transaction activities.
frozen - While Deposit are accepted, debit operations are blocked.
disabled - The account disallows any transactions.
deleted - The account has been terminated and reactivation is not possible.

active unverified frozen disabled deleted

firstName

string

The first name of the user.

lastName

string

The last name of the user.

string

length ≤ 303

Legitimate email ID of the card user. This entry should be distinct among all users.

phone

object

Phone number.

country

string

required

Phone country prefix (for instance, +33). It should begin with a '+'.

number

string

required

Phone number, not including the country prefix, with a maximum of 12 digits.

dateOfBirth

date

Date of birth of the card user in YYYY-MM-DD format.

countryOfBirth

string

Place of birth of the card user in ISO 3166-1 alpha-2 country code.

countryOfResidence

string

Country of residence of the card user in ISO 3166-1 alpha-2 country code.

address

object

address1

string

required

Number and street of the address (e.g., street or company name).

address2

string

Address complementary informations (e.g., apartment, place, or building).

postalCode

string

required

Postal code or ZIP of the address.

city

string

required

City of the address.

country

string

required

Country code of the address in ISO 3166-1 alpha-2. See the full list here

state

string

State, county, province, or region.

shippingAddress

object

address

object

Recipient address

phone

string

required

Phone number of the recipient. One string of digits only with optional + at the start.

legalName

object

The user's legal name as per KYC provider.

firstName

string

required

lastName

string

required

createdAt

date-time

Creation date

updatedAt

date-time

Last update date

wallet

object

A crypto wallet.

string

A Wallet identifier. Begins with 'wlt-' followed by a v4 UUID

name

string

Name for the Wallet.

userId

string

The UUID of the card holder user

status

string

Status of the Wallet.

unverified active frozen

address

string

a 42-character hexadecimal address beginning with 0x.

blockchain

string

A blockchain on which a wallet is deployed.

ethereum ethereum-sepolia arbitrum arbitrum-sepolia optimism optimism-goerli avalanche avalanche-fuji bsc bsc-testnet fuse fuse-spark base base-sepolia blast blast-sepolia solana solana-devnet rootstock rootstock-testnet polygon polygon-amoy starknet starknet-sepolia

verifiedAt

date-time

Verification date

publicKey

string

Kulipa public key created for the wallet. This key should have unlimited allowance on the ERC20 token contract.

projectSignature

A wallet signature created from a message and a wallet private key on a blockchain network. The body shape depends on the wallet network.

createdAt

date-time

Creation date

updatedAt

date-time

Last update date

400

The server cannot or will not process the request due to something that is perceived to be a client error (e.g., malformed request syntax, invalid request message framing, or deceptive request routing).

401

Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response.

403

The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401 Unauthorized, the client's identity is known to the server.

429

The user has sent too many requests in a given amount of time ("rate limiting").

500

The server has encountered a situation it does not know how to handle.

502

This error response means that the server, while working as a gateway to get a response needed to handle the request, got an invalid response.

503

The server is not ready to handle the request. Common causes are a server that is down for maintenance or that is overloaded.

504

This error response is given when the server is acting as a gateway and cannot get a response in time.

Language

Credentials

Header


xxxxxxxxxx
10
1
const options = {
2
  method: 'POST',
3
  headers: {accept: 'application/json', 'content-type': 'application/json'},
4
  body: JSON.stringify({wallet: {blockchain: 'ethereum'}})
5
};
6
7
fetch('https://example.com/users', options)
8
  .then(res => res.json())
9
  .then(res => console.log(res))
10
  .catch(err => console.error(err));

Choose an example:

application/json

201Created User and Wallet