Skip to content

ForgotUsernameFilter ​

Type: schema

TypeScript Definition ​

typescript
ForgotUsernameFilter: {{
            /** @description The `id` of a `linked` attribute from `GET /auth/attributes?kind=linked`. */
            attribute_id: string;
            /** @description The document number. Matches whatever its case and spaces. A KYC status (`not_submitted`, `submitted` or `rejected`) is refused. */
            value: string;
        };
        /**
         * ForgotUsernameUser
         * @description A user of the recovered account's business, as much as it takes to choose one: the name and the masked contact.
         */
}

OpenAPI Schema ​

json
{
  "title": "ForgotUsernameFilter",
  "type": "object",
  "externalDocs": {
    "url": "https://llm-docs.commercengine.io/storefront/schemas/ForgotUsernameFilter",
    "description": "API reference for the ForgotUsernameFilter schema"
  },
  "required": [
    "attribute_id",
    "value"
  ],
  "properties": {
    "attribute_id": {
      "description": "The `id` of a `linked` attribute from `GET /auth/attributes?kind=linked`.",
      "type": "string"
    },
    "value": {
      "description": "The document number. Matches whatever its case and spaces. A KYC status (`not_submitted`, `submitted` or `rejected`) is refused.",
      "type": "string"
    }
  }
}

Auto-generated from OpenAPI spec and TypeScript definitions

Last updated: