Apply for a USD IBAN

Request a USD deposit IBAN for a Live user. The call is synchronous; UR creates the USD IBAN immediately and it then appears under the USD key of depositBank in the BR profile. The user is identified by urId in the request body.

post

/v1/apply-usd-payin

Authorizations

X-Api-SignaturestringRequired

Partner Auth: EIP-191 signature by the partner's registered backend key, with X-Api-Deadline and optional X-Api-PublicKey headers. See the Signature and verify guide.

Header parameters

X-Api-SignaturestringRequired

0x-prefixed 65-byte hex EIP-191 signature over the Partner Auth message. See the Signature and verify guide.

X-Api-DeadlinestringRequired

Unix seconds. UR rejects the request when the current time is past the deadline. Keep the validity window at or under 5 minutes.

X-Api-PublicKeystringRequired

0x-prefixed partner signer address registered with UR.

Body

urIdintegerRequired

The user's URID (numeric token ID of the URID NFT).

remarkstringRequired

Free-text remark for the USD IBAN application.

Responses

200

Standard envelope. Business errors return HTTP 200 with a non-zero code.

application/json

Standard UR OpenAPI response envelope. code 0 means success; a non-zero code is a business error described by message.

codeintegerRequired

0 on success; non-zero business error code.

messagestringRequired

Human-readable explanation. May be empty on success.

post/v1/apply-usd-payin

POST /v1/apply-usd-payin HTTP/1.1
Host: openapi.ur.app
X-Api-Signature: text
X-Api-Deadline: text
X-Api-PublicKey: text
Content-Type: application/json
Accept: */*
Content-Length: 58

{
  "urId": 7123456789,
  "remark": "user requested USD deposits"
}

200

Standard envelope. Business errors return HTTP 200 with a non-zero code.

{
  "code": 0,
  "message": "",
  "data": {
    "applyId": 10001
  }
}