Get Public profile of a Chimoney User.

post/v0.2.4/accounts/public-profile

Request

Base URL
https://api.chimoney.io
Auth
API key in header X-API-KEY
TypeScript
https://skmtc.dev/chimoney/apis/chimoney-api-docs/docs/v0.2.4/accounts/public-profile/post.ts
A function with typed inputs. Its response is checked against the schema.

Request body

userIDstring

User ID of Chimoney user. Must provide one of userID, linkCode, p_id, or interledgerWalletAddress.

p_idstring

User Public profile ID of Chimoney user. Must provide one of userID, linkCode, p_id, or interledgerWalletAddress.

linkCodestring

NFC Link Code. Must provide one of userID, linkCode, p_id, or interledgerWalletAddress.

interledgerWalletAddressstring

Interledger wallet address (Payment Pointer) in format $ilp.chimoney.io/username or https://ilp.chimoney.io/username. Must provide one of userID, linkCode, p_id, or interledgerWalletAddress.

Example request

{
  "interledgerWalletAddress": "$ilp.chimoney.io/alice"
}

Response

Success.

statusstring

Status of the request.

messagestring

Success message.

Example response

{
  "status": "success",
  "message": "User profile retrieved successfully",
  "data": {
    "accountSecondCurrencies": [],
    "verification": {
      "status": "completed"
    },
    "paymentData": {
      "interledgerWalletAddress": "https://ilp-sandbox.chimoney.com/4252496"
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.