Account Members2

Accounts4

Address Verification4

API Credentials2

Claims5

Crypto Deposits2

Crypto Withdrawals3

Deposit Addresses2

Events2

Fees1

Fiat Transfers9

Identity4

Identity Controls3

Identity Documents2

Institution Members2

Internal Transfers1

Issuer Quotes4

Limits1

Market Data4

Monitoring Addresses4

Orchestration Rules3

Orchestrations3

Orders5

Paxos Transfers1

Payments1

Payout Groups4

Pricing3

Profiles7

Quote Executions3

Quotes1

Reward Addresses5

Rewards1

Rewards Statements2

Sandbox Deposits1

Sandbox Fiat Transfers1

Sandbox Identity4

Stablecoin Conversion4

Statements1

Tax Forms2

Transfers2

TravelRulePublic2

Profiles

Get Profile

Read a single profile by its UUID, or read the default profile using the alias "default".

get/profiles/{profile_id}

Request

Base URL
https://api.paxos.com/v2
Auth
OAuth 2
Client credentials
Token URLhttps://oauth.paxos.com/oauth2/token
Scopesfunding:read_profile
TypeScript
https://skmtc.dev/paxos/apis/paxos-api/docs/profiles/:profile_id/get.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

profile_idstring required

The UUID of the profile, or "default" for the default profile.

Query parameters

include_deactivatedboolean

Used to include deactivated profiles in the response.

Response

A successful response.

idstring required

nicknamestring required

type'NORMAL' | 'DEFAULT' required

The profile type.

NORMAL: A client-created profile. All Profiles created using the CreateProfile endpoint are of this type.
DEFAULT: A system-generated profile.

descriptionstring

account_idstring

Example response

{
  "id": "b7b77d82-e6a7-4ae9-9904-36231aedf985",
  "nickname": "MyProfileName",
  "type": "NORMAL"
}

Changes

No recorded changes to this operation across all 1 revision of this API.