Download OpenAPI specification:Download
The Accounts API allows you register users and to access user account information. You can use it to retrieve details such as the user's e-mail address or the account's block status. You can also use it to block, and in some cases unblock, user accounts.
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 one of the external_platforms
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 together in the same request. All other fields can be sent separately. For more information about this type of interaction, refer to External Payment Platforms.
Successful completion triggers this notification |
---|
Register account completed |
Account resource
username required | string <= 64 characters The desired username for the account. |
required | object The user's email information. If no |
object | |
full_name | string The 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. |
Account profile was registered successfully.
Invalid input
Unauthorized access.
Resource not found.
Resource already exists.
Service unavailable or server error.
{- "username": "string",
- "email": {
- "address": "user@example.com",
- "requires_verification": true
}, - "external_platforms": {
- "steam": {
- "user_id": "<steam_id>"
}, - "oculus": {
- "user_id": "<oculus_id>"
}, - "apple": {
- "user_id": "<apple_id>"
}, - "google": {
- "user_id": "<google_id>"
}, - "microsoft": {
- "user_id": "<microsoft_id>"
}, - "nintendo": {
- "user_id": "<nintendo_id>"
}, - "sony": {
- "user_id": "<sony_id>"
}
}, - "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"
}
{- "status": "Success",
- "message": null,
- "codes": null,
- "payload": {
- "account_id": "acct_2TiDFXHVFMlAuyy7ovvz3YPKv9b",
- "email": {
- "address": "user@example.com",
- "email_id": "string",
- "email_types": [
- "string"
], - "is_verified": true
}, - "external_platforms": {
- "apple": {
- "user_id": "<apple_id>"
}, - "google": {
- "user_id": "<google_id>"
}, - "microsoft": {
- "user_id": "<microsoft_id>"
}, - "nintendo": {
- "user_id": "<nintendo_id>"
}, - "oculus": {
- "user_id": "<oculus_id>"
}, - "sony": {
- "user_id": "<sony_id>"
}, - "steam": {
- "user_id": "<steam_id>"
}
}, - "username": "string",
- "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"
}
}