latestOpenAPI 3.1.02026-08-108094177.6 KB

087dcf516ce2

Delegated Contract Mode

Exchange authorization code for user info

Delegated Contract Mode will be deprecated soon; new partners should use Managed Custody Mode. Returns the user's UR identity and authorization information. Provide at least one of urId or authCode; the endpoint primarily uses urId today, and authCode (the one-time OAuth code, valid 5 minutes) supports the authorization-code exchange. Partner-signed request. An invalid or expired code returns code 4001.

post/v1/profile

Headers

X-Api-Signaturestring required

Partner's EIP-191 signature (0x-prefixed hex).

X-Api-Deadlinestring required

Unix seconds when the request signature expires (within 5 minutes).

X-Api-PublicKeystring

Partner's signer Ethereum address.

Request body

authCodestring

Authorization code from the OAuth redirect (one-time use, valid 5 minutes).

urIdinteger

UR user ID. The primary lookup parameter.

Response

Response envelope. For the user API, retCode 0 means success; for the partner API, code 0 means success. Business rejections return HTTP 200 with a non-zero code.

codeinteger required

0 on success; non-zero indicates a business rejection.

messagestring required

Human-readable diagnostic; empty on success.

{"stackTrail":"components:schemas:DcEnvelope:properties:data","oasType":"schema","type":"unknown","description":"Business payload. Shape depends on the endpoint."}