action biapi_post_connectors {
label: "Request a new connector"
description: "Send a request to add a new connector
"
provider: biapi
method: POST
path: "/connectors"
encoding: json
input: {
type: "object"
properties: {
expand: {
type: "string"
}
}
additionalProperties: false
}
output: {
type: "object"
required: ["beta", "charged", "id", "name", "restricted", "uuid"]
properties: {
auth_mechanism: {
type: "string"
description: "Authentication mechanism to use"
}
beta: {
type: "boolean"
description: "If true, this connector is perhaps unstable :)"
}
charged: {
type: "boolean"
description: "Usage of this connector is charged"
}
code: {
type: "string"
description: "Bank code"
}
color: {
type: "string"
description: "Main color of the bank or provider"
}
hidden: {
type: "boolean"
description: "This connector is hidden from your users"
}
id: {
type: "integer"
description: "ID of the connector"
}
months_to_fetch: {
type: "integer"
description: "How many months of history to fetch"
}
name: {
type: "string"
description: "Name of the bank or provider"
}
restricted: {
type: "boolean"
description: "If true, new connections cannot be added with this connector"
}
siret: {
type: "string"
description: "SIRET code for Bill modules"
}
slug: {
type: "string"
}
sync_frequency: {
type: "number"
format: "float"
description: "How many days to wait between syncs"
}
uuid: {
type: "string"
description: "Unique connector identifier"
}
}
}
}