Schema: AccountProfile

All schemas · API reference · Data mapping guide

Fields

Field	Required	Type / allowed values
subject	Yes	string
phone	Yes	string
platformRole	Yes	admin, user
user	Yes	object or null

JSON definition

The JSON retains the source contract descriptions. Do not translate property names or enum values.

{
  "type": "object",
  "properties": {
    "subject": {
      "type": "string"
    },
    "phone": {
      "type": "string"
    },
    "platformRole": {
      "type": "string",
      "enum": [
        "admin",
        "user"
      ]
    },
    "user": {
      "type": [
        "object",
        "null"
      ],
      "properties": {
        "id": {
          "type": "string"
        },
        "email": {
          "type": [
            "string",
            "null"
          ]
        },
        "firstName": {
          "type": "string"
        },
        "lastName": {
          "type": "string"
        },
        "isActive": {
          "type": "boolean"
        }
      },
      "required": [
        "id",
        "email",
        "firstName",
        "lastName",
        "isActive"
      ]
    }
  },
  "required": [
    "subject",
    "phone",
    "platformRole",
    "user"
  ],
  "example": {
    "subject": "user-demo-001",
    "phone": "+573000000000",
    "platformRole": "user",
    "user": {
      "id": "user-demo-001",
      "email": null,
      "firstName": "Persona",
      "lastName": "Ejemplo",
      "isActive": true
    }
  }
}