Start user registration

Creates a temporary registration profile that can be used in creating a new Tilia Pay account. This endpoint generates a registration_id that must be passed to PUT /v2/register/{registration_id} in order to complete the registration process.

Request
Security:
tilia_auth (write_registrations)
Request Body schema: application/json
username
required
string <= 254 characters

The desired username for this Tilia Pay account. Must be unique, and must be formatted as an email address.

password
required
string [ 6 .. 16 ] characters

Password for the Tilia Pay account. Must not contain the account's username or email address. Must contain at least one alphabetic character, and at least one numeric character or symbol.

email
required
string <= 254 characters

User email attached to the account. Must be a valid email address. Tilia uses this address when contacting the user about their account; you are required to notify Tilia of any changes to the user's email address.

tos
boolean

Indicates whether or not the account's owner has accepted the integrator's Terms of Service.

tracking_id
string <UUID>

An optional value that can be used to track a user through the registration and account creation process.

metadata
string

Additional information may be passed using this field. May include any serialized data (JWT, JSON, etc.). Data is not guaranteed to be secure; do not pass private account details. This data is unmodified by the service; however, we recommend you include a validation checksum to ensure data has not been manipulated in transit.

Responses
201

Successful registration response

400

Invalid registration data.

401

Unauthorized access.

500

Service unavailable or server error.

post/v2/register
Request samples
application/json
{
  • "username": "david_gaimer@mail.io",
  • "password": "J5Ks+%ML-Tx_/}Eb",
  • "email": "david_gaimer@mail.io",
  • "tos": true,
  • "tracking_id": "454471c2-e4c6-11ea-87d0-0242ac100000",
  • "metadata": "string"
}
Response samples
application/json
{
  • "status": "Success",
  • "message": null,
  • "codes": null,
  • "payload": {
    }
}