Skip to main content
API docs by Redocly

Welcome to the VAAS API Reference! (v1)

Download OpenAPI specification:Download

API Support: [email protected] URL: https://developers.vaas.live

Overview

Here, you'll find documentation on all our VAAS REST API endpoints.

Authentication

Direct API calls

For direct API calls, VAAS uses API keys for authentication on all API calls.

Clients must include an Authorization header with the value Basic {base64_encoded_credentials} for every API request. The {base64_encoded_credentials} should be a base64-encoded string in the format apiTokenId:apiTokenSecret.

To obtain API keys, please contact support.

API calls from third-party integration

Learn more about here.

HTTP Status Code

  • 200 - OK - Request processed as expected.
  • 400 - INVALID_REQUEST - Request is not well-formed, violates schema or incorrect fields.
  • 401 - NOT_AUTHORIZED - The API key doesn't match or doesn't have permissions to perform the request.
  • 403 - FORBIDDEN - The API key's permissions doesn't match the needed permission to complete the request.
  • 404 - RESOURCE_NOT_FOUND - The requested resource doesn't exist.
  • 429 - RATE_LIMIT_REACHED - Too many requests. Blocked due to rate limiting.
  • 5XX - Something went wrong on VAAS' end

Workflow

Operations about workflows.

Executes a workflow version.

Runs the specific version of a workflow.

The execution request body is dynamic and depends on the configured entrypoint data source for the workflow you want to execute. Below are examples of different possible request bodies.

Example - Onboarding PF

{
    "cpf": "87813245881",
    "name": "John Due",
    "phone": "8178829287",
    "eamil": "[email protected]"
}

Example - Onboarding PJ

{
    "cnpj": "69454356000100"
}

Example - Crypto wallet screening

{
    "address": "1FfmbHfnpaZjKFvyi1okTjJJusN455paPH"
}
path Parameters
workflowId
required
string
workflowVersionId
required
string
Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "output": {
    },
  • "error": {
    }
}

Executes a workflow.

Runs a workflow on your currently deployed version.

The execution request body is dynamic and depends on the configured entrypoint data source for the workflow you want to execute. Below are examples of different possible request bodies.

Example - Onboarding PF

{
    "cpf": "87813245881",
    "name": "John Due",
    "phone": "8178829287",
    "eamil": "[email protected]"
}

Example - Onboarding PJ

{
    "cnpj": "69454356000100"
}

Example - Crypto wallet screening

{
    "address": "1FfmbHfnpaZjKFvyi1okTjJJusN455paPH"
}
path Parameters
workflowId
required
string
Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "output": {
    },
  • "error": {
    }
}