Skip to content
/ActivityService

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

ActivityService

Operations

List all activity log types

Request

Security
oauth2_client_credentials or oauth2_authorization_code
Query
pageSizeinteger(int32)(page_size)

Optional. The maximum number of activity log types to return. The service may return fewer than this value. If unspecified, at most 50 activity log types 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 ListActivityLogType call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListActivityLogType must match the call that provided the page token.

showDeletedboolean(show_deleted)

Optional. If true, soft-deleted activity log types will be included in the response. See AIP-164.

skipinteger(int32)(skip)

Optional. The number of activity log types to skip before starting to collect the result set.

filterstring(filter)

Optional. A filter expression that filters the results listed in the response. Filter only currently supports a fuzzy search on display name. See AIP-160 for more details.

orderBystring(order_by)

(OPTIONAL)

curl -i -X GET \
  'https://docs.bndry.net/_mock/apis/openapi/v1alpha/activityLogTypes?pageSize=25&pageToken=ChAIAhABGAE&showDeleted=true&skip=50&filter=Customer+Sign+in&orderBy=name+desc' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Success

Bodyapplication/json
activityLogTypesArray of objects(activity_log_types)
nextPageTokenstring(next_page_token)

A token to retrieve the next page of results.

totalSizeinteger(int32)(total_size)

The total number of activity log types.

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

Create an activity log type

Request

Security
oauth2_client_credentials or oauth2_authorization_code
Query
activityLogTypeIdstring(activity_log_type_id)[ 4 .. 63 ] characters

Optional. The ID to use for the activity log type, which will become the final component of the resource name. This value should be 4-63 characters, and valid characters are /[a-z][0-9]-/.

Bodyapplication/json
namestring(name)

(IDENTIFIER)

labelstring(label)[ 4 .. 63 ] charactersrequired
curl -i -X POST \
  'https://docs.bndry.net/_mock/apis/openapi/v1alpha/activityLogTypes?activityLogTypeId=customer-sign-in' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "string",
    "label": "string"
  }'

Responses

Success

Bodyapplication/json
namestring(name)

(IDENTIFIER)

labelstring(label)[ 4 .. 63 ] charactersrequired
Response
application/json
{
  "name": "string",
  "label": "string"
}

Retrieve an activity log type

Request

Security
oauth2_client_credentials or oauth2_authorization_code
Path
activityLogTypestringrequired

The activityLogType id.

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

Responses

Success

Bodyapplication/json
namestring(name)

(IDENTIFIER)

labelstring(label)[ 4 .. 63 ] charactersrequired
Response
application/json
{
  "name": "string",
  "label": "string"
}

Update an activity log type

Request

Security
oauth2_client_credentials or oauth2_authorization_code
Path
activityLogTypestringrequired

The activityLogType id.

Query
updateMask.pathsArray of strings(paths)

The set of field mask paths.

Bodyapplication/json
namestring(name)

(IDENTIFIER)

labelstring(label)[ 4 .. 63 ] charactersrequired
curl -i -X PATCH \
  'https://docs.bndry.net/_mock/apis/openapi/v1alpha/activityLogTypes/{activityLogType}?updateMask.paths=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "string",
    "label": "string"
  }'

Responses

Success

Bodyapplication/json
namestring(name)

(IDENTIFIER)

labelstring(label)[ 4 .. 63 ] charactersrequired
Response
application/json
{
  "name": "string",
  "label": "string"
}

Entities

Operations

Entity Risk Rating

Service for managing risk rating jobs for individual entities.

Operations

Individual Entity Verification

Service for managing individual entity verification jobs.

Operations

Onboard Individual Entity

Service for managing individual entity onboarding jobs.

Operations

Entity PEP Sanctions Check

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

Operations