PluggyDocs
POST/connectors/{id}/validate

Validate

Validates a connector parameters usign the connector validation

Parameters

Path Parameters

NameType
idrequired
number (double)

Request Body

required

Connector's input credentials in a key-value object.

object

Key-Value credentials neccesary to create an item

<key>string

Example

json
{
  "user": "my-user",
  "password": "my-password"
}

Responses

200Connector validation response
object

Response to parameter's validations

errorsobject[]
itemsobject
parametersobject

Key-Value credentials neccesary to create an item

<key>string

Example response

json
{
  "parameters": {
    "user": "my-user",
    "password": "1234"
  },
  "errors": [
    {
      "code": "002",
      "message": "A senha deve ter pelo menos 6 dígitos.",
      "parameter": "password",
      "data": {
        "min": 6
      }
    }
  ]
}
curl -X POST \
  'https://api.pluggy.ai/connectors/{id}/validate' \
  -H 'Content-Type: application/json' \
  -H 'X-API-KEY: YOUR_API_KEY' \
  -d '{}'
Sample response
{
  "parameters": {
    "user": "my-user",
    "password": "1234"
  },
  "errors": [
    {
      "code": "002",
      "message": "A senha deve ter pelo menos 6 dígitos.",
      "parameter": "password",
      "data": {
        "min": 6
      }
    }
  ]
}