Retrieve user's own profile

Retrieves the user's own profile as requested by the user.

SecurityAPI Key: SecretApiKey or HTTP: JWT
get
/profile
Request samples
const profile = await api.profile.get();
console.log(profile.fields.email);
Responses

200

Profile retrieved.

Response Schema: application/json
id
string (ResourceId) <= 50 characters

Unique resource ID.

email
string <email> <= 100 characters

Email address of the user.

firstName
string

User's first name.

lastName
string

User's last name.

businessPhone
string or null

User's business phone number.

mobilePhone
string or null

User's mobile phone number.

permissions
Array of strings <operationId>

Permissions that the user has within organizations. Use the wildcard character * for full access.

createdTime
string <date-time> (CreatedTime)

Date and time which is set automatically when the resource is created.

updatedTime
string <date-time> (UpdatedTime)

Date and time which updates automatically when the resource is updated.

availableCurrencies
Array of strings

Array of reporting currencies that are enabled for the merchant.

reportingCurrency
string

User's currency code in ISO 4217 format. This value is used for reports.

loginTime
string or null <date-time>

Date and time when the user last logged in.

status
string

Status of the user account.

Enum: "active" "inactive" "pending-confirmation"
country
string

User's country of residence in ISO 3166 alpha-2 country code. For examples, see ISO.org.

preferences
object or null

User preferences, such as: timezone, language, and more. This is an object with custom properties.

hasPermissionsEmulation
boolean

Specifies if the current user session has permissions emulation enabled.

displayName
string

User's full display name.

hash
string

Unique hash value that represents the user.

Array of objects (SelfLink)

Related links.

401

Unauthorized access. Invalid credentials used.

403

Access forbidden.

404

Resource not found.

Response samples
application/json
{ "id": "4f6cf35x-2c4y-483z-a0a9-158621f77a21", "email": "user@example.com", "firstName": "string", "lastName": "string", "businessPhone": "string", "mobilePhone": "string", "permissions": [ "PostFile", "StorefrontGetAccount", "StorefrontGetWebsite", "StorefrontGetKycDocumentCollection", "StorefrontGetKycDocument", "StorefrontPostKycDocument" ], "createdTime": "2019-08-24T14:15:22Z", "updatedTime": "2019-08-24T14:15:22Z", "availableCurrencies": [ "string" ], "reportingCurrency": "string", "loginTime": "2019-08-24T14:15:22Z", "status": "active", "country": "string", "preferences": { }, "hasPermissionsEmulation": true, "displayName": "string", "hash": "string", "_links": [ ] }