Skip to content
API Reference/
/
Retrieve a form

BNDRY API (v1alpha)

API for the BNDRY platform

Download OpenAPI description
openapi.json
openapi.yaml
Overview
License

MIT License

Languages
Servers
Mock server

https://docs.bndry.net/_mock/apis/openapi/

BNDRY API

https://api.bndry.app/

Forms

Operations

Retrieve a form

Request

Retrieves a form.

Security
oauth2_client_credentials or oauth2_authorization_code
Path
formstringrequired

The form id.

curl -i -X GET \
  'https://docs.bndry.net/_mock/apis/openapi/v1alpha/forms/{form}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Success

Bodyapplication/json
namestring(name)

(IDENTIFIER) The resource name of the form. Format: forms/{form} Format: workspaces/{workspace}/forms/{form}

formDefinitionstring(form_definition)

(IMMUTABLE) Immutable. The resource name of the form definition used to create this form. Format: formDefinitions/{form_definition} string.example = ["formDefinitions/kyc-beneficial-ownership"]

formkitSchemaobject(bndry.api.datacollection.forms.v1alpha.FormKitSchema)read-only
responseobject(google.protobuf.Struct)required
response.​property name*null or number or string or boolean or Array of arrays or object(google.protobuf.Value)additional property
One of:

Value represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error.

The JSON representation for Value is JSON value.

null
createTimestring(date-time)(google.protobuf.Timestamp)read-only
updateTimestring(date-time)(google.protobuf.Timestamp)read-only
etagstring(etag)

(OPTIONAL) Optional. The etag of the resource. Used for optimistic concurrency control as per AIP-154.

displayNamestring(display_name)

(OPTIONAL) Optional. A mutable, user-settable field for providing a human-readable name for the form, to be used in user interfaces. Must be <= 63 characters. string.example = ["KYC Identity Verification - Jane Smith"]

workspacesArray of strings(workspaces)

(OPTIONAL)

automationsArray of strings(automations)

(OPTIONAL)

statestring(bndry.api.datacollection.forms.v1alpha.Form.State)read-only
Enum"STATE_UNSPECIFIED""OPEN""EXPIRED""SUBMITTED"
Response
application/json
{
  "name": "string",
  "formDefinition": "formDefinitions/kyc-beneficial-ownership",
  "formkitSchema": {
    "nodes": { … }
  },
  "response": {
    "property1": {},
    "property2": {}
  },
  "createTime": "2023-01-15T01:30:15.01Z",
  "updateTime": "2023-01-15T01:30:15.01Z",
  "etag": "string",
  "displayName": "KYC Identity Verification - Jane Smith",
  "workspaces": [
    "workspaces/due-diligence-ws-123"
  ],
  "automations": [
    "automations/kyc-risk-assessment-auto-456"
  ],
  "state": "STATE_UNSPECIFIED"
}

Update a form

Request

Updates a form.

Security
oauth2_client_credentials or oauth2_authorization_code
Path
formstringrequired

The form id.

Query
updateMask.pathsArray of strings(paths)

The set of field mask paths.

Bodyapplication/json

Required. The form to update.

The form's name field is used to identify the form to update. Format: forms/{form} Format: workspaces/{workspace}/forms/{form}

namestring(name)

(IDENTIFIER) The resource name of the form. Format: forms/{form} Format: workspaces/{workspace}/forms/{form}

formDefinitionstring(form_definition)

(IMMUTABLE) Immutable. The resource name of the form definition used to create this form. Format: formDefinitions/{form_definition} string.example = ["formDefinitions/kyc-beneficial-ownership"]

responseobject(google.protobuf.Struct)required
response.​property name*null or number or string or boolean or Array of arrays or object(google.protobuf.Value)additional property
One of:

Value represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error.

The JSON representation for Value is JSON value.

null
etagstring(etag)

(OPTIONAL) Optional. The etag of the resource. Used for optimistic concurrency control as per AIP-154.

displayNamestring(display_name)

(OPTIONAL) Optional. A mutable, user-settable field for providing a human-readable name for the form, to be used in user interfaces. Must be <= 63 characters. string.example = ["KYC Identity Verification - Jane Smith"]

workspacesArray of strings(workspaces)

(OPTIONAL)

automationsArray of strings(automations)

(OPTIONAL)

curl -i -X PATCH \
  'https://docs.bndry.net/_mock/apis/openapi/v1alpha/forms/{form}?updateMask.paths=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "string",
    "formDefinition": "formDefinitions/kyc-beneficial-ownership",
    "formkitSchema": {
      "nodes": {
        "values": [
          {}
        ]
      }
    },
    "response": {
      "property1": {},
      "property2": {}
    },
    "createTime": "2023-01-15T01:30:15.01Z",
    "updateTime": "2023-01-15T01:30:15.01Z",
    "etag": "string",
    "displayName": "KYC Identity Verification - Jane Smith",
    "workspaces": [
      "workspaces/due-diligence-ws-123"
    ],
    "automations": [
      "automations/kyc-risk-assessment-auto-456"
    ],
    "state": "STATE_UNSPECIFIED"
  }'

Responses

Success

Bodyapplication/json
namestring(name)

(IDENTIFIER) The resource name of the form. Format: forms/{form} Format: workspaces/{workspace}/forms/{form}

formDefinitionstring(form_definition)

(IMMUTABLE) Immutable. The resource name of the form definition used to create this form. Format: formDefinitions/{form_definition} string.example = ["formDefinitions/kyc-beneficial-ownership"]

formkitSchemaobject(bndry.api.datacollection.forms.v1alpha.FormKitSchema)read-only
responseobject(google.protobuf.Struct)required
response.​property name*null or number or string or boolean or Array of arrays or object(google.protobuf.Value)additional property
One of:

Value represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error.

The JSON representation for Value is JSON value.

null
createTimestring(date-time)(google.protobuf.Timestamp)read-only
updateTimestring(date-time)(google.protobuf.Timestamp)read-only
etagstring(etag)

(OPTIONAL) Optional. The etag of the resource. Used for optimistic concurrency control as per AIP-154.

displayNamestring(display_name)

(OPTIONAL) Optional. A mutable, user-settable field for providing a human-readable name for the form, to be used in user interfaces. Must be <= 63 characters. string.example = ["KYC Identity Verification - Jane Smith"]

workspacesArray of strings(workspaces)

(OPTIONAL)

automationsArray of strings(automations)

(OPTIONAL)

statestring(bndry.api.datacollection.forms.v1alpha.Form.State)read-only
Enum"STATE_UNSPECIFIED""OPEN""EXPIRED""SUBMITTED"
Response
application/json
{
  "name": "string",
  "formDefinition": "formDefinitions/kyc-beneficial-ownership",
  "formkitSchema": {
    "nodes": { … }
  },
  "response": {
    "property1": {},
    "property2": {}
  },
  "createTime": "2023-01-15T01:30:15.01Z",
  "updateTime": "2023-01-15T01:30:15.01Z",
  "etag": "string",
  "displayName": "KYC Identity Verification - Jane Smith",
  "workspaces": [
    "workspaces/due-diligence-ws-123"
  ],
  "automations": [
    "automations/kyc-risk-assessment-auto-456"
  ],
  "state": "STATE_UNSPECIFIED"
}

List all forms

Request

List all forms.

Security
oauth2_client_credentials or oauth2_authorization_code
Query
parentstring(parent)required

Required. The parent workspace for which to list forms. Format: forms/ Format: workspaces/{workspace}

pageSizeinteger(int32)(page_size)

Optional. The maximum number of forms to return. The service may return fewer than this value. If unspecified, at most 50 forms will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.

pageTokenstring(page_token)

Optional. A page token, received from a previous ListWorkspaceForms call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListWorkspaceForms must match the call that provided the page token.

skipinteger(int32)(skip)

Optional. The number of forms to skip before starting to collect the result set.

curl -i -X GET \
  'https://docs.bndry.net/_mock/apis/openapi/v1alpha/forms?parent=workspaces%2Faml-monitoring-ws-456&pageSize=0&pageToken=string&skip=0' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Success

Bodyapplication/json
formsArray of objects(forms)

The list of workspace forms.

nextPageTokenstring(next_page_token)

A token to retrieve the next page of results, or empty if there are no more results in the list.

totalSizeinteger(int32)(total_size)

The total number of forms matching the request.

Response
application/json
{
  "forms": [
    { … }
  ],
  "nextPageToken": "string",
  "totalSize": 0
}

Create a form

Request

Creates a form.

Security
oauth2_client_credentials or oauth2_authorization_code
Query
formIdstring(form_id)

(OPTIONAL) string.example = ["compliance-form-202412-001"]

Bodyapplication/json
namestring(name)

(IDENTIFIER) The resource name of the form. Format: forms/{form} Format: workspaces/{workspace}/forms/{form}

formDefinitionstring(form_definition)

(IMMUTABLE) Immutable. The resource name of the form definition used to create this form. Format: formDefinitions/{form_definition} string.example = ["formDefinitions/kyc-beneficial-ownership"]

responseobject(google.protobuf.Struct)required
response.​property name*null or number or string or boolean or Array of arrays or object(google.protobuf.Value)additional property
One of:

Value represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error.

The JSON representation for Value is JSON value.

null
etagstring(etag)

(OPTIONAL) Optional. The etag of the resource. Used for optimistic concurrency control as per AIP-154.

displayNamestring(display_name)

(OPTIONAL) Optional. A mutable, user-settable field for providing a human-readable name for the form, to be used in user interfaces. Must be <= 63 characters. string.example = ["KYC Identity Verification - Jane Smith"]

workspacesArray of strings(workspaces)

(OPTIONAL)

automationsArray of strings(automations)

(OPTIONAL)

curl -i -X POST \
  'https://docs.bndry.net/_mock/apis/openapi/v1alpha/forms?formId=compliance-form-202412-001' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "string",
    "formDefinition": "formDefinitions/kyc-beneficial-ownership",
    "formkitSchema": {
      "nodes": {
        "values": [
          {}
        ]
      }
    },
    "response": {
      "property1": {},
      "property2": {}
    },
    "createTime": "2023-01-15T01:30:15.01Z",
    "updateTime": "2023-01-15T01:30:15.01Z",
    "etag": "string",
    "displayName": "KYC Identity Verification - Jane Smith",
    "workspaces": [
      "workspaces/due-diligence-ws-123"
    ],
    "automations": [
      "automations/kyc-risk-assessment-auto-456"
    ],
    "state": "STATE_UNSPECIFIED"
  }'

Responses

Success

Bodyapplication/json
namestring(name)

(IDENTIFIER) The resource name of the form. Format: forms/{form} Format: workspaces/{workspace}/forms/{form}

formDefinitionstring(form_definition)

(IMMUTABLE) Immutable. The resource name of the form definition used to create this form. Format: formDefinitions/{form_definition} string.example = ["formDefinitions/kyc-beneficial-ownership"]

formkitSchemaobject(bndry.api.datacollection.forms.v1alpha.FormKitSchema)read-only
responseobject(google.protobuf.Struct)required
response.​property name*null or number or string or boolean or Array of arrays or object(google.protobuf.Value)additional property
One of:

Value represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error.

The JSON representation for Value is JSON value.

null
createTimestring(date-time)(google.protobuf.Timestamp)read-only
updateTimestring(date-time)(google.protobuf.Timestamp)read-only
etagstring(etag)

(OPTIONAL) Optional. The etag of the resource. Used for optimistic concurrency control as per AIP-154.

displayNamestring(display_name)

(OPTIONAL) Optional. A mutable, user-settable field for providing a human-readable name for the form, to be used in user interfaces. Must be <= 63 characters. string.example = ["KYC Identity Verification - Jane Smith"]

workspacesArray of strings(workspaces)

(OPTIONAL)

automationsArray of strings(automations)

(OPTIONAL)

statestring(bndry.api.datacollection.forms.v1alpha.Form.State)read-only
Enum"STATE_UNSPECIFIED""OPEN""EXPIRED""SUBMITTED"
Response
application/json
{
  "name": "string",
  "formDefinition": "formDefinitions/kyc-beneficial-ownership",
  "formkitSchema": {
    "nodes": { … }
  },
  "response": {
    "property1": {},
    "property2": {}
  },
  "createTime": "2023-01-15T01:30:15.01Z",
  "updateTime": "2023-01-15T01:30:15.01Z",
  "etag": "string",
  "displayName": "KYC Identity Verification - Jane Smith",
  "workspaces": [
    "workspaces/due-diligence-ws-123"
  ],
  "automations": [
    "automations/kyc-risk-assessment-auto-456"
  ],
  "state": "STATE_UNSPECIFIED"
}

Submit a form

Request

Submits a form.

Security
oauth2_client_credentials or oauth2_authorization_code
Path
formstringrequired

The form id.

curl -i -X POST \
  'https://docs.bndry.net/_mock/apis/openapi/v1alpha/forms/{form}:submit' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Success

Bodyapplication/json
submitTimestring(date-time)(google.protobuf.Timestamp)
Response
application/json
{
  "submitTime": "2023-01-15T01:30:15.01Z"
}

Entities

Operations

Entity Risk Rating

Service for managing risk rating jobs for individual entities.

Operations

Onboard Individual (Verify Identity)

Service for managing individual entity onboarding jobs.

Operations

Entity PEP Sanctions Check

Service for managing PEP and sanctions screening jobs for individual entities.

Operations