Проверка существования аккаунтов

GET 
/api/account/exists

Проверяет, существуют ли аккаунты Volet.com для переданных адресов электронной почты из песочницы.

Запрос

Параметры Query

emailsToValidate string[]обязательно
Адреса электронной почты для проверки. Используйте только адреса из песочницы или тестовые адреса.
Пример: [email protected]

Ответы

200

OK

application/json

Схема

Схема

• Array [
accountEmailstring
Email аккаунта.
Пример: [email protected]
presentboolean
Признак наличия.
Пример: true
transactionScoreint32
Оценка транзакции.
Пример: 1
verifiedboolean
Признак верификации.
Пример: true
• ]

Пример

[
  {
    "accountEmail": "[email protected]",
    "present": true,
    "transactionScore": 1,
    "verified": true
  }
]

400

Некорректный запрос. Запрос сформирован неверно или содержит недопустимые параметры.

application/json

Схема

Схема

statusstringобязательно
Статус ответа.
Возможные значения: [error]
Пример: error
data objectобязательно
Данные ответа с ошибкой.
errors object[]обязательно
Список ошибок, возвращённых для запроса.
Array [
errorMessagestringобязательно
Постоянный машиночитаемый код ошибки.
Пример: disabled
errorTypestringобязательно
Категория ошибки.
Пример: FORM
errorIdstringобязательно
Короткий уникальный идентификатор ошибки для поддержки и логов.
Пример: errTest1234
errorDescriptionstringобязательно
Описание ошибки для человека.
Пример: REQUESTED OPERATION IS DISABLED FOR THE MERCHANT API
errorFieldstringnullable
Поле запроса, к которому относится ошибка, если есть.
Пример: null
paramsobject[]обязательно
Дополнительные параметры ошибки.
requestParamsobjectобязательно
Параметры запроса, сохранённые для диагностики.
]

Пример

{
  "status": "error",
  "data": {
    "errors": [
      {
        "errorMessage": "disabled",
        "errorType": "FORM",
        "errorId": "errTest1234",
        "errorDescription": "REQUESTED OPERATION IS DISABLED FOR THE MERCHANT API",
        "errorField": null,
        "params": [],
        "requestParams": {}
      }
    ]
  }
}

401

Не авторизован. Заголовки аутентификации мерчанта отсутствуют или недействительны.

application/json

Схема

Схема

statusstringобязательно
Статус ответа.
Возможные значения: [error]
Пример: error
data objectобязательно
Данные ответа с ошибкой.
errors object[]обязательно
Список ошибок, возвращённых для запроса.
Array [
errorMessagestringобязательно
Постоянный машиночитаемый код ошибки.
Пример: userDoesNotExistException
errorTypestringобязательно
Категория ошибки.
Пример: GENERAL
errorIdstringобязательно
Короткий уникальный идентификатор ошибки для поддержки и логов.
Пример: errTest1234
errorDescriptionstringобязательно
Описание ошибки для человека.
Пример: NOT FOUND API WITH ACCOUNT_EMAIL: [email protected]
errorFieldstringnullable
Поле запроса, к которому относится ошибка, если есть.
Пример: null
paramsobject[]обязательно
Дополнительные параметры ошибки.
requestParamsobjectобязательно
Параметры запроса, сохранённые для диагностики.
]

Пример

{
  "status": "error",
  "data": {
    "errors": [
      {
        "errorMessage": "userDoesNotExistException",
        "errorType": "GENERAL",
        "errorId": "errTest1234",
        "errorDescription": "NOT FOUND API WITH ACCOUNT_EMAIL: [email protected]",
        "errorField": null,
        "params": [],
        "requestParams": {}
      }
    ]
  }
}

404

Не найдено. Запрошенный ресурс не существует.

application/json

Схема

Схема

statusstringобязательно
Статус ответа.
Возможные значения: [error]
Пример: error
data objectобязательно
Данные ответа с ошибкой.
errors object[]обязательно
Список ошибок, возвращённых для запроса.
Array [
errorMessagestringобязательно
Постоянный машиночитаемый код ошибки.
Пример: resourceNotFound
errorTypestringобязательно
Категория ошибки.
Пример: GENERAL
errorIdstringобязательно
Короткий уникальный идентификатор ошибки для поддержки и логов.
Пример: errTest1234
errorDescriptionstringобязательно
Описание ошибки для человека.
Пример: Resource not found
errorFieldstringnullable
Поле запроса, к которому относится ошибка, если есть.
Пример: null
paramsobject[]обязательно
Дополнительные параметры ошибки.
requestParamsobjectобязательно
Параметры запроса, сохранённые для диагностики.
]

Пример

{
  "status": "error",
  "data": {
    "errors": [
      {
        "errorMessage": "resourceNotFound",
        "errorType": "GENERAL",
        "errorId": "errTest1234",
        "errorDescription": "Resource not found",
        "errorField": null,
        "params": [],
        "requestParams": {}
      }
    ]
  }
}

500

Внутренняя ошибка сервера. Непредвиденная ошибка, обратитесь в поддержку

application/json

Схема

Схема

statusstringобязательно
Статус ответа.
Возможные значения: [error]
Пример: error
data objectобязательно
Данные ответа с ошибкой.
errors object[]обязательно
Список ошибок, возвращённых для запроса.
Array [
errorMessagestringобязательно
Постоянный машиночитаемый код ошибки.
Пример: internalServerError
errorTypestringобязательно
Категория ошибки.
Пример: GENERAL
errorIdstringобязательно
Короткий уникальный идентификатор ошибки для поддержки и логов.
Пример: errTest1234
errorDescriptionstringобязательно
Описание ошибки для человека.
Пример: Internal server error
errorFieldstringnullable
Поле запроса, к которому относится ошибка, если есть.
Пример: null
paramsobject[]обязательно
Дополнительные параметры ошибки.
requestParamsobjectобязательно
Параметры запроса, сохранённые для диагностики.
]

Пример

{
  "status": "error",
  "data": {
    "errors": [
      {
        "errorMessage": "internalServerError",
        "errorType": "GENERAL",
        "errorId": "errTest1234",
        "errorDescription": "Internal server error",
        "errorField": null,
        "params": [],
        "requestParams": {}
      }
    ]
  }
}