---
updatedAt: 2025-02-14T21:02:04.000Z
agentTools:
  projectIndex: https://docs.kontempo.io/llms.txt
---

# Verify Buyer User Login via Phone

Endpoint that will be called from Checkout. Buyer user submits secret code they received via SMS initiated when /phone-submit was called

# OpenAPI definition

```json
{
  "openapi": "3.0.0",
  "paths": {
    "/v1/buyers/login/phone-verify": {
      "post": {
        "operationId": "BuyersController_loginViaPhoneVerify",
        "summary": "Verify Buyer User Login via Phone",
        "description": "Endpoint that will be called from Checkout. Buyer user submits secret code they received via SMS initiated when /phone-submit was called",
        "parameters": [
          {
            "name": "X-Api-Secret",
            "in": "header",
            "description": "Merchant Api Secret",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "X-Api-Key",
            "in": "header",
            "description": "Merchant Api Key",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/PhoneVerify"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LoginUserOutput"
                }
              }
            }
          },
          "429": {
            "description": "",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/MaxCheckAttemptsReachedErrorResponse"
                }
              }
            }
          },
          "500": {
            "description": "",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/InternalServerErrorErrorResponse"
                }
              }
            }
          }
        },
        "tags": [
          "Buyers"
        ]
      }
    }
  },
  "info": {
    "title": "Kontempo Merchant API",
    "description": "",
    "version": "1.0.0",
    "contact": {}
  },
  "servers": [
    {
      "url": "https://partners.kontempo.io"
    }
  ],
  "components": {
    "schemas": {
      "InternalServerErrorErrorResponse": {
        "type": "object",
        "properties": {
          "statusCode": {
            "type": "number",
            "example": 500
          },
          "message": {
            "type": "string"
          }
        },
        "required": [
          "statusCode",
          "message"
        ]
      },
      "PhoneVerify": {
        "type": "object",
        "properties": {
          "code": {
            "type": "string"
          },
          "phone": {
            "type": "string"
          }
        },
        "required": [
          "code",
          "phone"
        ]
      },
      "BuyerUser": {
        "type": "object",
        "properties": {
          "pkey": {
            "type": "string"
          },
          "account": {
            "type": "string"
          },
          "first_name": {
            "type": "string",
            "example": "John"
          },
          "last_name": {
            "type": "string",
            "example": "Doe"
          },
          "email": {
            "type": "string",
            "example": "john@doe.com"
          },
          "created": {
            "type": "number",
            "example": 1644243150
          },
          "status": {
            "type": "number",
            "example": 1
          },
          "archived": {
            "type": "number",
            "example": 0
          },
          "last_login": {
            "type": "string"
          },
          "password": {
            "type": "string",
            "example": "notpassword123"
          },
          "phone": {
            "type": "string",
            "example": "+38162111222"
          },
          "roles": {
            "type": "array",
            "items": {
              "type": "string",
              "enum": [
                "administrator",
                "user",
                "finance"
              ]
            }
          },
          "token": {
            "type": "string"
          },
          "reset_token": {
            "type": "string"
          },
          "notes": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "settings": {
            "type": "object"
          },
          "attributes": {
            "type": "object"
          }
        },
        "required": [
          "pkey",
          "account",
          "first_name",
          "last_name",
          "email",
          "created",
          "status",
          "archived",
          "last_login",
          "password"
        ]
      },
      "LoginUserOutput": {
        "type": "object",
        "properties": {
          "token": {
            "type": "string"
          },
          "user": {
            "$ref": "#/components/schemas/BuyerUser"
          }
        },
        "required": [
          "token",
          "user"
        ]
      },
      "MaxCheckAttemptsReachedErrorResponse": {
        "type": "object",
        "properties": {
          "statusCode": {
            "type": "number",
            "example": 429
          },
          "message": {
            "type": "string"
          }
        },
        "required": [
          "statusCode",
          "message"
        ]
      }
    }
  },
  "x-readme": {
    "explorer-enabled": true,
    "proxy-enabled": true
  }
}
```