Skip to navigation

Check whether a P2P username is free

Whether username is free across every tenant. The account’s own current username counts as free. Does not say who holds a taken name. Scope p2p.ads or p2p.trade.

Authentication

AuthorizationBearer

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

Path parameters

accountIdstringRequired
Account identifier.
usernamestringRequiredformat: "^[a-z0-9_.]{3,24}$"
Candidate username.

Headers

X-Tenant-IdstringRequired
Tenant context used for authorization and routing.
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.

Response

Availability
usernamestringOptional
availablebooleanOptional

Errors

403
Forbidden Error
404
Not Found Error
422
Unprocessable Entity Error