Onboarding/OffChain

Server-side create user

Changed on

Creates a new user in the Wirex system using server-side Wirex Partner Credentials authorization.

post/api/v1/user

Request

  • Base URL
    https://api-baas.wirexapp.com
  • URL
    https://api-baas.wirexapp.com/api/v1/user
  • Auth
    • HTTP bearer
    • or API key in header X-Chain-Id and API key in header Authorization

Request body

countrystring required

The residence country of the user. This should be an Alpha-2 code. (e.g., US, GB, DE)

emailstring required

The email address of the user that would be registered. This address should be unique, otherwise, the request will fail.

user_addressstring

EOA of the user, compliant with the format of the chain you're using. This address should be unique, otherwise, the request will fail. Preferred over wallet_address; either field may be supplied.

wallet_addressstring

Deprecated: still accepted for backward compatibility, but callers should send user_address — this field carries the user's EOA, which is now accepted as user_address. Either field may be supplied; if both are provided they must match.

Example request

{
  "country": "FR",
  "email": "a.grey@wirexpay.com",
  "user_address": "0xA7E41d5680dE394EaA2ed417169DFf56840Fb3EE",
  "wallet_address": "0xA7E41d5680dE394EaA2ed417169DFf56840Fb3EE"
}

Response

OK

idstring required

Identifier of the created entity

Example response

{
  "id": "123e4567-e89b-12d3-a456-426655440000"
}

Changes