Onboarding/OffChain

[V2] Server-side create user

Changed on

Creates a new user in the Wirex system using server-side Wirex Partner Credentials authorization. Optionally accepts sharing_token or initial_data for KYC registration.

post/api/v2/user

Request

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

Request body

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

{
  "initial_data": {
    "profile": {
      "date_of_birth": "1990-01-15",
      "email": "john.doe@example.com",
      "first_name": "John",
      "last_name": "Doe",
      "nationality": "US",
      "phone_number": "+14155551234"
    },
    "residence_address": {
      "city": "San Francisco",
      "country": "US",
      "line1": "123 Main Street",
      "line2": "Apt 4B",
      "post_code": "94105",
      "state": "CA"
    }
  },
  "sharing_data": {
    "email": "alex.grey@wirexapp.com",
    "sharing_token": "wirexpay_sharing_123"
  },
  "user_address": "0xA7E41d5680dE394EaA2ed417169DFf56840Fb3EE",
  "wallet_address": "0xA7E41d5680dE394EaA2ed417169DFf56840Fb3EE"
}

Response

OK

idstring required

Identifier of the created entity

Example response

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

Changes