Register account

Register a new user account. Each user account must be created with at least one of the following: user's email address or user_ID from an external payment provider (e.g. Steam or Oculus).

When a value for external payment platform is specified, a special 'Pay on Behalf of' (POBO) payment method will be created for the user, which can be used in subsequent transactions. If provided, full name and address details will be associated with the user's POBO payment method. When providing PII state_province and country_iso must be sent in the request together; all other fields can be sent on their own. For more information on this type of interaction, refer to External Payment Platforms.

Request
Security:
tilia_auth (write_registrations)
Request Body schema: application/json

Account resource

username
required
string <= 64 characters

The desired username for the account.

object

The email information for the user.

object
full_name
string

Full name of the person associated with the payment method.

street_address_1
string

Address line 1 of the billing address (e.g., street, P.O. Box, or company name).

street_address_2
string

Address line 2 of the billing address (e.g., unit, apartment, suite, or building).

street_address_3
string

Address line 3 of the billing address.

city
string

City of the billing address.

state_province
string

State or Province of the billing address.

country_iso
string

2-letter ISO 3166 Country code of the billing address.

zip_postal_code
string

Zip or postal code of the billing address.

Responses
200

Account profile was registered successfully.

400

Invalid input

401

Unauthorized access.

404

Resource not found.

409

Resource already exists.

500

Service unavailable or server error.

post/register
Request samples
application/json
{
  • "username": "string",
  • "email": {
    },
  • "external_platforms": {
    },
  • "full_name": "Jessica Pley",
  • "street_address_1": "1 Alden Way",
  • "street_address_2": "BLDG 3",
  • "street_address_3": "APT 6",
  • "city": "Atlanta",
  • "state_province": "GA",
  • "country_iso": "US",
  • "zip_postal_code": "30301"
}
Response samples
application/json
{
  • "status": "Success",
  • "message": null,
  • "codes": null,
  • "payload": {
    }
}