Skip to navigation

Set the P2P profile contact

Saves the e-mail and phone used to sign P2P contracts and sends a confirmation code to each channel that is not confirmed yet. Holder only. The body must not include a document: an individual signs with the account document, a company signs with the holder CPF from X-Acting-Document (role owner) and representativeName is that holder’s name. Changing a channel clears its confirmation. On a company, a different holder clears both. Requires a username first (username_required).

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.

X-Acting-RoleenumOptional

owner when X-Acting-Document is the holder of a company account. Without it, a company holder is refused (holder_only). An individual account ignores the role: the acting document must be the account document.

Allowed values:
Idempotency-KeystringOptional

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

X-Request-TimestampstringRequired

Unix seconds. Required on the signed host; tolerance is 300s either way (403 request_timestamp_skew).

X-Content-SHA256stringRequired

Lowercase hex SHA-256 of the body. An empty body hashes the empty string, so the header is always present. Mismatch returns 400 body_hash_mismatch.

X-Request-SignaturestringRequired

Detached JWS (<protected>..<signature>, ES256 or PS256) over METHOD\nPATH?QUERY\nTIMESTAMP\nIDEMPOTENCY_KEY_OR_EMPTY\nX_CONTENT_SHA256.

Request

This endpoint expects an object.
emailstringRequiredformat: "email"
phonestringRequired

Brazilian mobile, with or without +55.

representativeNamestringOptional

Holder name. Companies only; rejected for individuals.

emailVerifiedbooleanOptional

The tenant attests it already verified this e-mail as the user’s (for example, the internet banking login e-mail confirmed by code). The channel is saved confirmed (emailVerifiedBy: tenant) and no code is sent. Send it only for a value you verified yourself.

phoneVerifiedbooleanOptional

Same as emailVerified, for the phone.

Response

Profile, with masked contact.
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

400
Bad Request Error
403
Forbidden Error
409
Conflict Error
422
Unprocessable Entity Error
429
Too Many Requests Error
503
Service Unavailable Error