Errors

A valid request must include a valid API key, a model name, and at least one of the following for verification: first name, last name, or email.

cURL

curl --request POST \
  --url https://api.vishodi.com/api/v1 \
  --header 'Content-Type: application/json' \
  --header 'X-API-Token: <api-key>' \
  --data '{
  "model": "<string>",
  "email": "<string>",
  "firstname": "<string>",
  "lastname": "<string>"
}'

No Authentication Token Provided, Response (422):

bash

{
  "detail": [
    {
      "type": "missing",
      "loc": [
        "header",
        "X-API-Token"
      ],
      "msg": "Field required",
      "input": null
    }
  ]
}

Invalid Authentication Token, Response (401):

bash

{
  "detail": "Invalid API token"
}

Invalid Tool Name, Response (400):

cURL

curl --request POST \
  --url https://api.vishodi.com/api/v1 \
  --header 'Content-Type: application/json' \
  --header 'X-API-Token: VALID_API' \
  --data '{
  "model": "INVALID_NAME",
  "email": "<string>",
  "firstname": "<string>",
  "lastname": "<string>"
}'

bash

{
  "detail": "Invalid Tool name"
}

Missing Tool Name, Response (422):

bash

{
  "detail": [
    {
      "type": "missing",
      "loc": [
        "body",
        "model"
      ],
      "msg": "Field required",
      "input": {}
    }
  ]
}

Plan Upgrade Required, Response (402):

bash

{
  "detail": "You have to upgrade your plan"
}

Empty String, Response (400):

cURL

curl --request POST \
  --url https://api.vishodi.com/api/v1 \
  --header 'Content-Type: application/json' \
  --header 'X-API-Token: VALID_API' \
  --data '{
  "model": "user_verification",
  "email": "",
  "firstname": "",
  "lastname": ""
}'

bash

{
  "detail": "No valid data provided for verification"
}

Server-Side Error, Response (503):

bash

{
  "detail": "Tool service unavailable"
}

Get Started

User Verification

Essentials

No Authentication Token Provided, Response (422):

Invalid Authentication Token, Response (401):

Invalid Tool Name, Response (400):

Missing Tool Name, Response (422):

Plan Upgrade Required, Response (402):

Empty String, Response (400):

Server-Side Error, Response (503):

​No Authentication Token Provided, Response (422):

​Invalid Authentication Token, Response (401):

​Invalid Tool Name, Response (400):

​Missing Tool Name, Response (422):

​Plan Upgrade Required, Response (402):

​Empty String, Response (400):

​Server-Side Error, Response (503):

No Authentication Token Provided, Response (422):

Invalid Authentication Token, Response (401):

Invalid Tool Name, Response (400):

Missing Tool Name, Response (422):

Plan Upgrade Required, Response (402):

Empty String, Response (400):

Server-Side Error, Response (503):