Skip to content
vocapable.Docs

Reserve a target for scoped customer access

POST
/v1/customer-connectors
curl --request POST \
  --url https://api.vocapable.com/v1/customer-connectors \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "target_id": "example", "display_name": "example", "policy": { "version": 1, "hints": [ "customer_reference" ], "templates": { "additionalProperty": [ "display_name" ] }, "verification_methods": [ "on_file_channel_otp" ], "grant_seconds": 300, "max_data_age_seconds": 30, "max_searches_per_call": 3, "max_challenges_per_call": 2, "max_lookups_per_call": 10 } }'

Authorizations

Section titled “Authorizations”

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
CustomerConnectorCreate
object
target_id
required
Target Id
string
>= 1 characters <= 128 characters
display_name
required
Display Name
string
>= 1 characters <= 100 characters
policy
required
CustomerAccessPolicy
object
version
Version
integer
default: 1
Allowed value: 1
hints
required
Hints
Array<string>
>= 1 items <= 3 items
Allowed values: customer_reference order_reference business_reference
templates
required
Templates
object
>= 1 properties <= 4 properties
key
additional properties
Array<string>
Allowed values: display_name account_status customer_since order_reference service_status expected_date appointment_reference appointment_time appointment_status invoice_reference amount_minor currency payment_status due_date
verification_methods
required
Verification Methods
Array<string>
>= 1 items <= 2 items
Allowed values: on_file_channel_otp authenticated_customer_app
grant_seconds
Grant Seconds
integer
default: 300 >= 30 <= 600
max_data_age_seconds
Max Data Age Seconds
integer
default: 30 <= 300
max_searches_per_call
Max Searches Per Call
integer
default: 3 >= 1 <= 5
max_challenges_per_call
Max Challenges Per Call
integer
default: 2 >= 1 <= 3
max_lookups_per_call
Max Lookups Per Call
integer
default: 10 >= 1 <= 20

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
CustomerConnectorOut
object
target_id
required
Target Id
string
>= 1 characters <= 128 characters
display_name
required
Display Name
string
>= 1 characters <= 100 characters
policy
required
CustomerAccessPolicy
object
version
Version
integer
default: 1
Allowed value: 1
hints
required
Hints
Array<string>
>= 1 items <= 3 items
Allowed values: customer_reference order_reference business_reference
templates
required
Templates
object
>= 1 properties <= 4 properties
key
additional properties
Array<string>
Allowed values: display_name account_status customer_since order_reference service_status expected_date appointment_reference appointment_time appointment_status invoice_reference amount_minor currency payment_status due_date
verification_methods
required
Verification Methods
Array<string>
>= 1 items <= 2 items
Allowed values: on_file_channel_otp authenticated_customer_app
grant_seconds
Grant Seconds
integer
default: 300 >= 30 <= 600
max_data_age_seconds
Max Data Age Seconds
integer
default: 30 <= 300
max_searches_per_call
Max Searches Per Call
integer
default: 3 >= 1 <= 5
max_challenges_per_call
Max Challenges Per Call
integer
default: 2 >= 1 <= 3
max_lookups_per_call
Max Lookups Per Call
integer
default: 10 >= 1 <= 20
id
required
Id
string
state
required
State
string
Allowed values: enabled disabled
configuration_sha256
required
Configuration Sha256
string
/^[a-f0-9]{64}$/
created_at
required
Created At
string format: date-time
Example
{
  "policy": {
    "version": 1,
    "hints": [
      "customer_reference"
    ],
    "templates": {
      "additionalProperty": [
        "display_name"
      ]
    },
    "verification_methods": [
      "on_file_channel_otp"
    ],
    "grant_seconds": 300,
    "max_data_age_seconds": 30,
    "max_searches_per_call": 3,
    "max_challenges_per_call": 2,
    "max_lookups_per_call": 10
  },
  "state": "enabled"
}

422

Section titled “422”

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context
object
Examplegenerated
{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example",
      "input": "example",
      "ctx": {}
    }
  ]
}