Validate account existence

GET 
/api/account/exists

Checks whether one or more Volet.com accounts exist for the supplied sandbox email addresses.

Request

Query Parameters

emailsToValidate string[]required
Email addresses to validate. Use only sandbox or test addresses.
Example: [email protected]

Responses

200

OK

application/json

Schema

Schema

• Array [
accountEmailstring
Account Email.
Example: [email protected]
presentboolean
Present.
Example: true
transactionScoreint32
Transaction Score.
Example: 1
verifiedboolean
Verified.
Example: true
• ]

Example

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

400

Bad request. The request is malformed or contains invalid parameters.

application/json

Schema

Schema

statusstringrequired
Response status.
Possible values: [error]
Example: error
data objectrequired
Error response payload.
errors object[]required
List of errors returned for the request.
Array [
errorMessagestringrequired
Stable machine-readable error code.
Example: disabled
errorTypestringrequired
Error category.
Example: FORM
errorIdstringrequired
Short unique error identifier for support and logs.
Example: errTest1234
errorDescriptionstringrequired
Human-readable error description.
Example: REQUESTED OPERATION IS DISABLED FOR THE MERCHANT API
errorFieldstringnullable
Request field related to the error, if any.
Example: null
paramsobject[]required
Additional error parameters.
requestParamsobjectrequired
Request parameters captured for diagnostics.
]

Example

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

401

Unauthorized. Merchant authentication headers are missing or invalid.

application/json

Schema

Schema

statusstringrequired
Response status.
Possible values: [error]
Example: error
data objectrequired
Error response payload.
errors object[]required
List of errors returned for the request.
Array [
errorMessagestringrequired
Stable machine-readable error code.
Example: userDoesNotExistException
errorTypestringrequired
Error category.
Example: GENERAL
errorIdstringrequired
Short unique error identifier for support and logs.
Example: errTest1234
errorDescriptionstringrequired
Human-readable error description.
Example: NOT FOUND API WITH ACCOUNT_EMAIL: [email protected]
errorFieldstringnullable
Request field related to the error, if any.
Example: null
paramsobject[]required
Additional error parameters.
requestParamsobjectrequired
Request parameters captured for diagnostics.
]

Example

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

404

Not found. The requested resource does not exist.

application/json

Schema

Schema

statusstringrequired
Response status.
Possible values: [error]
Example: error
data objectrequired
Error response payload.
errors object[]required
List of errors returned for the request.
Array [
errorMessagestringrequired
Stable machine-readable error code.
Example: resourceNotFound
errorTypestringrequired
Error category.
Example: GENERAL
errorIdstringrequired
Short unique error identifier for support and logs.
Example: errTest1234
errorDescriptionstringrequired
Human-readable error description.
Example: Resource not found
errorFieldstringnullable
Request field related to the error, if any.
Example: null
paramsobject[]required
Additional error parameters.
requestParamsobjectrequired
Request parameters captured for diagnostics.
]

Example

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

500

Internal server error. Unexpected error please contact support

application/json

Schema

Schema

statusstringrequired
Response status.
Possible values: [error]
Example: error
data objectrequired
Error response payload.
errors object[]required
List of errors returned for the request.
Array [
errorMessagestringrequired
Stable machine-readable error code.
Example: internalServerError
errorTypestringrequired
Error category.
Example: GENERAL
errorIdstringrequired
Short unique error identifier for support and logs.
Example: errTest1234
errorDescriptionstringrequired
Human-readable error description.
Example: Internal server error
errorFieldstringnullable
Request field related to the error, if any.
Example: null
paramsobject[]required
Additional error parameters.
requestParamsobjectrequired
Request parameters captured for diagnostics.
]

Example

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