Stellar · Schema

CreateReceiverRequest

BlockchainCryptocurrencyDecentralized ExchangeLedgerPaymentsSmart ContractsWeb3
View JSON Schema on GitHub

JSON Schema

stellar-sdp-createreceiverrequest.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://developers.stellar.org/schemas/sdp/CreateReceiverRequest.json",
  "title": "CreateReceiverRequest",
  "oneOf": [
    {
      "type": "object",
      "required": [
        "external_id",
        "verifications"
      ],
      "properties": {
        "email": {
          "type": "string",
          "description": "Email address of the receiver",
          "format": "email"
        },
        "phone_number": {
          "type": "string",
          "description": "Phone number of the receiver"
        },
        "external_id": {
          "type": "string",
          "description": "External identifier for the receiver"
        },
        "verifications": {
          "type": "array",
          "description": "Verification requirements for the receiver",
          "items": {
            "type": "object",
            "properties": {
              "type": {
                "type": "string",
                "enum": [
                  "date_of_birth",
                  "pin",
                  "national_id",
                  "year_month"
                ],
                "description": "Type of verification required"
              },
              "value": {
                "type": "string",
                "description": "Expected verification value"
              }
            },
            "required": [
              "type",
              "value"
            ]
          }
        }
      }
    },
    {
      "type": "object",
      "required": [
        "external_id",
        "wallets"
      ],
      "properties": {
        "email": {
          "type": "string",
          "description": "Email address of the receiver",
          "format": "email"
        },
        "phone_number": {
          "type": "string",
          "description": "Phone number of the receiver"
        },
        "external_id": {
          "type": "string",
          "description": "External identifier for the receiver"
        },
        "wallets": {
          "type": "array",
          "description": "Wallet information for the receiver (max 1 wallet)",
          "items": {
            "type": "object",
            "properties": {
              "address": {
                "type": "string",
                "description": "Stellar address of the wallet"
              },
              "memo": {
                "type": "string",
                "description": "Optional memo for the wallet address"
              }
            },
            "required": [
              "address"
            ]
          },
          "maxItems": 1
        }
      }
    }
  ]
}