Skip to navigation

Set the P2P username

Sets the public username (3–24 characters: lowercase letters, digits, _ and .). Holder only: with X-Acting-Document, it must be the account holder’s document. Creating the profile does not count as a change; after each change the next one is accepted only 90 days later (409 username_change_too_soon, with details.nextChangeAt). Sending the current username is a no-op. Check a name first with GET .../p2p/usernames/{username}/availability.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

accountIdstringRequired
Account identifier.

Headers

X-Tenant-IdstringRequired
Tenant context used for authorization and routing.
X-Acting-DocumentstringOptional

CPF of the human performing the operation. Required on cashout routes when the credential enforces a transaction PIN. On a company P2P profile contact, this CPF is the holder who signs; it is not taken from the body.

Idempotency-KeystringOptional

Optional client-generated idempotency token (recommended for safe retries).

Request

This endpoint expects an object.
usernamestringRequiredformat: "^[a-z0-9_.]{3,24}$"

Response

Profile
accountIdstringOptional
Account.
usernamestring or nullOptional
Username.
usernameChangedAtdatetime or nullOptional

Last username change. null while the username is the one the profile was created with.

usernameNextChangeAtdatetime or nullOptional

From when a new username is accepted (90 days after the last change). null when it can change now.

advertiserStatusenumOptional
Advertiser status.
Allowed values:
advertiserNotestringOptional
CorpX note on refusal or suspension.
levelstring or nullOptional
Advertiser level.
orderCapstring or nullOptional

Per-order cap for this advertiser.

feeBpsintegerOptional

Fee, in basis points of the order amount, charged to this account on the orders of its own ads: the seller receives the amount minus the fee on a sell ad, the buyer pays the amount plus the fee on a buy ad. Comes from the level; without a level, the lowest level’s fee applies. 0 when the market has no levels.

memberSincedatetime or nullOptional
Profile creation.
reputationobjectOptional

Trading statistics. Values below the tenant’s minimum number of orders are null.

contactobjectOptional

E-mail and phone confirmed on the P2P profile, masked. The signer document is never sent by the client: for an individual it is the account document, for a company it is the holder who confirmed the contact.

Errors

403
Forbidden Error
404
Not Found Error
409
Conflict Error
422
Unprocessable Entity Error