API Reference
/
Forms
/
Expire a form

Download OpenAPI description
openapi.json
openapi.yaml
Languages
Servers
Mock server

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

https://bndry.app/api/

Documents

Service for managing documents.

Operations

Form Definitions

Service for managing form definitions.

Operations

Forms

Operations

Retrieve a form

Request

Retrieves a form.

Security
oauth2_client_credentials or oauth2_authorization_code
Path
formstringrequired

The form id.

Query
namestring(name)required

Required. The resource name of the workspace form to retrieve. Format: forms/{form} Format: workspaces/{workspace}/forms/{form}

curl -i -X GET \
  'https://docs.bndry.net/_mock/apis/openapi/v1alpha/forms/{form}?name=string' \
  -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}

formkitSchemaobject(bndry.api.datacollection.forms.v1alpha.FormKitSchema)read-only

Output only. The schema of the form, derived from the form definition.

responseobject(google.protobuf.Struct)required

Required. The responses to the form questions, stored as a JSON object.

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

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.

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

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.

createTimestring(date-time)(google.protobuf.Timestamp)read-only

Output only. The timestamp when the form was created.

updateTimestring(date-time)(google.protobuf.Timestamp)read-only

Output only. The timestamp when the form was most recently updated.

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.

workspacesArray of strings(workspaces)

(OPTIONAL)

automationsArray of strings(automations)

(OPTIONAL)

statestring(bndry.api.datacollection.forms.v1alpha.Form.State)read-only

Output only. The current state of the form. State can be changed using custom methods like CloseForm or SubmitForm.

Enum"STATE_UNSPECIFIED""OPEN""EXPIRED""SUBMITTED"
Response
application/json
{
  "name": "string",
  "formDefinition": "string",
  "formkitSchema": {
    "nodes": { … }
  },
  "response": {
    "property1": {},
    "property2": {}
  },
  "createTime": "1s",
  "updateTime": "1s",
  "etag": "string",
  "displayName": "string",
  "workspaces": [
    "string"
  ],
  "automations": [
    "string"
  ],
  "state": "STATE_UNSPECIFIED"
}

Update a form

Request

Updates a form.

Security
oauth2_client_credentials or oauth2_authorization_code
Path
formstringrequired

The form id.

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}

responseobject(google.protobuf.Struct)required

Required. The responses to the form questions, stored as a JSON object.

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

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.

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

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.

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.

workspacesArray of strings(workspaces)

(OPTIONAL)

automationsArray of strings(automations)

(OPTIONAL)

curl -i -X PATCH \
  'https://docs.bndry.net/_mock/apis/openapi/v1alpha/forms/{form}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "string",
    "formDefinition": "string",
    "formkitSchema": {
      "nodes": {
        "values": [
          {}
        ]
      }
    },
    "response": {
      "property1": {},
      "property2": {}
    },
    "createTime": "1s",
    "updateTime": "1s",
    "etag": "string",
    "displayName": "string",
    "workspaces": [
      "string"
    ],
    "automations": [
      "string"
    ],
    "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}

formkitSchemaobject(bndry.api.datacollection.forms.v1alpha.FormKitSchema)read-only

Output only. The schema of the form, derived from the form definition.

responseobject(google.protobuf.Struct)required

Required. The responses to the form questions, stored as a JSON object.

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

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.

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

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.

createTimestring(date-time)(google.protobuf.Timestamp)read-only

Output only. The timestamp when the form was created.

updateTimestring(date-time)(google.protobuf.Timestamp)read-only

Output only. The timestamp when the form was most recently updated.

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.

workspacesArray of strings(workspaces)

(OPTIONAL)

automationsArray of strings(automations)

(OPTIONAL)

statestring(bndry.api.datacollection.forms.v1alpha.Form.State)read-only

Output only. The current state of the form. State can be changed using custom methods like CloseForm or SubmitForm.

Enum"STATE_UNSPECIFIED""OPEN""EXPIRED""SUBMITTED"
Response
application/json
{
  "name": "string",
  "formDefinition": "string",
  "formkitSchema": {
    "nodes": { … }
  },
  "response": {
    "property1": {},
    "property2": {}
  },
  "createTime": "1s",
  "updateTime": "1s",
  "etag": "string",
  "displayName": "string",
  "workspaces": [
    "string"
  ],
  "automations": [
    "string"
  ],
  "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?pageSize=0&pageToken=string&parent=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
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}

responseobject(google.protobuf.Struct)required

Required. The responses to the form questions, stored as a JSON object.

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

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.

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

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.

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.

workspacesArray of strings(workspaces)

(OPTIONAL)

automationsArray of strings(automations)

(OPTIONAL)

curl -i -X POST \
  https://docs.bndry.net/_mock/apis/openapi/v1alpha/forms \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "string",
    "formDefinition": "string",
    "formkitSchema": {
      "nodes": {
        "values": [
          {}
        ]
      }
    },
    "response": {
      "property1": {},
      "property2": {}
    },
    "createTime": "1s",
    "updateTime": "1s",
    "etag": "string",
    "displayName": "string",
    "workspaces": [
      "string"
    ],
    "automations": [
      "string"
    ],
    "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}

formkitSchemaobject(bndry.api.datacollection.forms.v1alpha.FormKitSchema)read-only

Output only. The schema of the form, derived from the form definition.

responseobject(google.protobuf.Struct)required

Required. The responses to the form questions, stored as a JSON object.

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

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.

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

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.

createTimestring(date-time)(google.protobuf.Timestamp)read-only

Output only. The timestamp when the form was created.

updateTimestring(date-time)(google.protobuf.Timestamp)read-only

Output only. The timestamp when the form was most recently updated.

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.

workspacesArray of strings(workspaces)

(OPTIONAL)

automationsArray of strings(automations)

(OPTIONAL)

statestring(bndry.api.datacollection.forms.v1alpha.Form.State)read-only

Output only. The current state of the form. State can be changed using custom methods like CloseForm or SubmitForm.

Enum"STATE_UNSPECIFIED""OPEN""EXPIRED""SUBMITTED"
Response
application/json
{
  "name": "string",
  "formDefinition": "string",
  "formkitSchema": {
    "nodes": { … }
  },
  "response": {
    "property1": {},
    "property2": {}
  },
  "createTime": "1s",
  "updateTime": "1s",
  "etag": "string",
  "displayName": "string",
  "workspaces": [
    "string"
  ],
  "automations": [
    "string"
  ],
  "state": "STATE_UNSPECIFIED"
}

Submit a form

Request

Submits a form.

Security
oauth2_client_credentials or oauth2_authorization_code
Path
formstringrequired

The form id.

Bodyapplication/jsonrequired
namestring(name)required

Required. The resource name of the form to submit. Format: forms/{form}

curl -i -X POST \
  'https://docs.bndry.net/_mock/apis/openapi/v1alpha/forms/{form}:submit' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "string"
  }'

Responses

Success

Bodyapplication/json
submitTimestring(date-time)(google.protobuf.Timestamp)

The timestamp when the form was submitted.

Response
application/json
{
  "submitTime": "1s"
}

Expire a form

Request

Expires a form.

Security
oauth2_client_credentials or oauth2_authorization_code
Path
formstringrequired

The form id.

Bodyapplication/jsonrequired
namestring(name)required

Required. The resource name of the form to expire. Format: forms/{form}

curl -i -X POST \
  'https://docs.bndry.net/_mock/apis/openapi/v1alpha/forms/{form}:expire' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "string"
  }'

Responses

Success

Bodyapplication/json
expireTimestring(date-time)(google.protobuf.Timestamp)

The timestamp when the form was expired.

Response
application/json
{
  "expireTime": "1s"
}

Workspaces

Service for managing workspaces and their associated forms and documents.

Operations

Automations

Service for managing and executing automations.

Operations

Notes

Operations

Tenants

Service for managing tenants.

Operations

Entities

Operations

Individual Entity Onboarding

Service for managing individual entity onboarding jobs.

Operations

Truuth

TruuthService provides an API for the BNDRY SPA to initiate a new verification session with Truuth

Operations