{ "openapi": "3.1.0", "info": { "title": "BNDRY API", "description": "API for the BNDRY platform", "license": { "name": "MIT License", "url": "https://github.com/bndry-co/docs.bndry.net" }, "version": "v1alpha" }, "servers": [ { "url": "https://api.bndry.app", "description": "BNDRY API" } ], "paths": { "/v1alpha/activityLogTypes": { "get": { "tags": [ "ActivityService" ], "summary": "List all activity log types", "operationId": "ActivityService_ListActivityLogType", "parameters": [ { "name": "pageSize", "in": "query", "description": "Optional. The maximum number of activity log types to return. The service may return fewer than\n this value.\n If unspecified, at most 50 activity log types will be returned.\n The maximum value is 1000; values above 1000 will be coerced to 1000.", "required": false, "schema": { "type": "integer", "examples": [ 25 ], "title": "page_size", "format": "int32", "description": "(OPTIONAL) Optional. The maximum number of activity log types to return. The service may return fewer than\n this value.\n If unspecified, at most 50 activity log types will be returned.\n The maximum value is 1000; values above 1000 will be coerced to 1000." } }, { "name": "pageToken", "in": "query", "description": "Optional. A page token, received from a previous `ListActivityLogType` call.\n Provide this to retrieve the subsequent page.\n When paginating, all other parameters provided to `ListActivityLogType` must\n match the call that provided the page token.", "required": false, "schema": { "type": "string", "examples": [ "ChAIAhABGAE" ], "title": "page_token", "description": "(OPTIONAL) Optional. A page token, received from a previous `ListActivityLogType` call.\n Provide this to retrieve the subsequent page.\n When paginating, all other parameters provided to `ListActivityLogType` must\n match the call that provided the page token." } }, { "name": "showDeleted", "in": "query", "description": "Optional. If true, soft-deleted activity log types will be included in the response.\n See AIP-164.", "required": false, "schema": { "type": "boolean", "title": "show_deleted", "description": "(OPTIONAL) Optional. If true, soft-deleted activity log types will be included in the response.\n See AIP-164." } }, { "name": "skip", "in": "query", "description": "Optional. The number of activity log types to skip before starting to collect the result set.", "required": false, "schema": { "type": "integer", "examples": [ 50 ], "title": "skip", "format": "int32", "description": "(OPTIONAL) Optional. The number of activity log types to skip before starting to collect the result set." } }, { "name": "filter", "in": "query", "description": "Optional. A filter expression that filters the results listed in the response.\n Filter only currently supports a fuzzy search on display name.\n See AIP-160 for more details.", "required": false, "schema": { "type": "string", "examples": [ "Customer Sign in" ], "title": "filter", "description": "(OPTIONAL) Optional. A filter expression that filters the results listed in the response.\n Filter only currently supports a fuzzy search on display name.\n See AIP-160 for more details." } }, { "name": "orderBy", "in": "query", "required": false, "schema": { "type": "string", "examples": [ "name desc" ], "title": "order_by", "description": "(OPTIONAL) " } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/bndry.api.risk.entities.v1alpha.ListActivityLogTypeResponse" } } } } } }, "post": { "tags": [ "ActivityService" ], "summary": "Create an activity log type", "operationId": "ActivityService_CreateActivityLogType", "parameters": [ { "name": "activityLogTypeId", "in": "query", "description": "Optional. The ID to use for the activity log type, which will become the final component of\n the resource name. This value should be 4-63 characters,\n and valid characters are /[a-z][0-9]-/.", "required": false, "schema": { "type": "string", "examples": [ "customer-sign-in" ], "title": "activity_log_type_id", "maxLength": 63, "minLength": 4, "description": "(OPTIONAL) Optional. The ID to use for the activity log type, which will become the final component of\n the resource name. This value should be 4-63 characters,\n and valid characters are /[a-z][0-9]-/." } } ], "requestBody": { "content": { "application/json": { "schema": { "title": "activity_log_type", "$ref": "#/components/schemas/bndry.api.risk.entities.v1alpha.ActivityLogType" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/bndry.api.risk.entities.v1alpha.ActivityLogType" } } } } } } }, "/v1alpha/activityLogTypes/{activityLogType}": { "get": { "tags": [ "ActivityService" ], "summary": "Retrieve an activity log type", "operationId": "ActivityService_GetActivityLogType", "parameters": [ { "name": "activityLogType", "in": "path", "description": "The activityLogType id.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/bndry.api.risk.entities.v1alpha.ActivityLogType" } } } } } }, "patch": { "tags": [ "ActivityService" ], "summary": "Update an activity log type", "operationId": "ActivityService_UpdateActivityLogType", "parameters": [ { "name": "activityLogType", "in": "path", "description": "The activityLogType id.", "required": true, "schema": { "type": "string" } }, { "name": "updateMask", "in": "query", "description": "Optional. The list of fields to be updated.\n\n If not provided (i.e., the mask is omitted), the server will update all\n fields that are populated in the `activity_log_type` message in this request\n (i.e., fields that have a non-empty value).\n\n The special value `*` can be used for a full replacement of the resource,\n equivalent to a PUT operation. When using `*`, be cautious as new fields\n added to the resource in the future will also be updated.\n\n For robust updates, explicitly specifying the fields is recommended.\n\n See AIP-134 (Standard Update) and AIP-161 (Field Masks) for more details.", "required": false, "schema": { "type": "string", "description": "`FieldMask` represents a set of symbolic field paths, for example:\n\n paths: \"f.a\"\n paths: \"f.b.d\"\n\n Here `f` represents a field in some root message, `a` and `b`\n fields in the message found in `f`, and `d` a field found in the\n message in `f.b`.\n\n Field masks are used to specify a subset of fields that should be\n returned by a get operation or modified by an update operation.\n Field masks also have a custom JSON encoding (see below).\n\n # Field Masks in Projections\n\n When used in the context of a projection, a response message or\n sub-message is filtered by the API to only contain those fields as\n specified in the mask. For example, if the mask in the previous\n example is applied to a response message as follows:\n\n f {\n a : 22\n b {\n d : 1\n x : 2\n }\n y : 13\n }\n z: 8\n\n The result will not contain specific values for fields x,y and z\n (their value will be set to the default, and omitted in proto text\n output):\n\n\n f {\n a : 22\n b {\n d : 1\n }\n }\n\n A repeated field is not allowed except at the last position of a\n paths string.\n\n If a FieldMask object is not present in a get operation, the\n operation applies to all fields (as if a FieldMask of all fields\n had been specified).\n\n Note that a field mask does not necessarily apply to the\n top-level response message. In case of a REST get operation, the\n field mask applies directly to the response, but in case of a REST\n list operation, the mask instead applies to each individual message\n in the returned resource list. In case of a REST custom method,\n other definitions may be used. Where the mask applies will be\n clearly documented together with its declaration in the API. In\n any case, the effect on the returned resource/resources is required\n behavior for APIs.\n\n # Field Masks in Update Operations\n\n A field mask in update operations specifies which fields of the\n targeted resource are going to be updated. The API is required\n to only change the values of the fields as specified in the mask\n and leave the others untouched. If a resource is passed in to\n describe the updated values, the API ignores the values of all\n fields not covered by the mask.\n\n If a repeated field is specified for an update operation, new values will\n be appended to the existing repeated field in the target resource. Note that\n a repeated field is only allowed in the last position of a `paths` string.\n\n If a sub-message is specified in the last position of the field mask for an\n update operation, then new value will be merged into the existing sub-message\n in the target resource.\n\n For example, given the target message:\n\n f {\n b {\n d: 1\n x: 2\n }\n c: [1]\n }\n\n And an update message:\n\n f {\n b {\n d: 10\n }\n c: [2]\n }\n\n then if the field mask is:\n\n paths: [\"f.b\", \"f.c\"]\n\n then the result will be:\n\n f {\n b {\n d: 10\n x: 2\n }\n c: [1, 2]\n }\n\n An implementation may provide options to override this default behavior for\n repeated and message fields.\n\n In order to reset a field's value to the default, the field must\n be in the mask and set to the default value in the provided resource.\n Hence, in order to reset all fields of a resource, provide a default\n instance of the resource and set all fields in the mask, or do\n not provide a mask as described below.\n\n If a field mask is not present on update, the operation applies to\n all fields (as if a field mask of all fields has been specified).\n Note that in the presence of schema evolution, this may mean that\n fields the client does not know and has therefore not filled into\n the request will be reset to their default. If this is unwanted\n behavior, a specific service may require a client to always specify\n a field mask, producing an error if not.\n\n As with get operations, the location of the resource which\n describes the updated values in the request message depends on the\n operation kind. In any case, the effect of the field mask is\n required to be honored by the API.\n\n ## Considerations for HTTP REST\n\n The HTTP kind of an update operation which uses a field mask must\n be set to PATCH instead of PUT in order to satisfy HTTP semantics\n (PUT must only be used for full updates).\n\n # JSON Encoding of Field Masks\n\n In JSON, a field mask is encoded as a single string where paths are\n separated by a comma. Fields name in each path are converted\n to/from lower-camel naming conventions.\n\n As an example, consider the following message declarations:\n\n message Profile {\n User user = 1;\n Photo photo = 2;\n }\n message User {\n string display_name = 1;\n string address = 2;\n }\n\n In proto a field mask for `Profile` may look as such:\n\n mask {\n paths: \"user.display_name\"\n paths: \"photo\"\n }\n\n In JSON, the same mask is represented as below:\n\n {\n mask: \"user.displayName,photo\"\n }\n\n # Field Masks and Oneof Fields\n\n Field masks treat fields in oneofs just as regular fields. Consider the\n following message:\n\n message SampleMessage {\n oneof test_oneof {\n string name = 4;\n SubMessage sub_message = 9;\n }\n }\n\n The field mask can be:\n\n mask {\n paths: \"name\"\n }\n\n Or:\n\n mask {\n paths: \"sub_message\"\n }\n\n Note that oneof type names (\"test_oneof\" in this case) cannot be used in\n paths.\n\n ## Field Mask Verification\n\n The implementation of any API method which has a FieldMask type field in the\n request should verify the included field paths, and return an\n `INVALID_ARGUMENT` error if any path is unmappable." } } ], "requestBody": { "content": { "application/json": { "schema": { "title": "activity_log_type", "$ref": "#/components/schemas/bndry.api.risk.entities.v1alpha.ActivityLogType" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/bndry.api.risk.entities.v1alpha.ActivityLogType" } } } } } } }, "/v1alpha/activityLogs": { "post": { "tags": [ "Entities" ], "summary": "Create an activity log", "operationId": "EntityService_CreateActivityLog", "parameters": [ { "name": "activityLogId", "in": "query", "description": "Optional. The ID to use for the entity, which will become the final component of\n the entity's resource name. This value should be 4-63 characters,\n and valid characters are /[a-z][0-9]-/.", "required": false, "schema": { "type": "string", "examples": [ "activity-log-001" ], "title": "activity_log_id", "maxLength": 63, "minLength": 4, "description": "(OPTIONAL) Optional. The ID to use for the entity, which will become the final component of\n the entity's resource name. This value should be 4-63 characters,\n and valid characters are /[a-z][0-9]-/." } } ], "requestBody": { "description": "Required. The entity to create.", "content": { "application/json": { "schema": { "title": "activity_log", "description": "Required. The entity to create.", "$ref": "#/components/schemas/bndry.api.risk.entities.v1alpha.ActivityLog" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/bndry.api.risk.entities.v1alpha.ActivityLog" } } } } } } }, "/v1alpha/activityLogs/{activityLog}": { "get": { "tags": [ "Entities" ], "summary": "Retrieve an activity log", "description": "Retrieves an activity.", "operationId": "EntityService_GetActivityLog", "parameters": [ { "name": "activityLog", "in": "path", "description": "The activityLog id.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/bndry.api.risk.entities.v1alpha.ActivityLog" } } } } } }, "delete": { "tags": [ "Entities" ], "summary": "Delete an activity log", "description": "Soft-deletes an activity log.", "operationId": "EntityService_DeleteActivityLog", "parameters": [ { "name": "activityLog", "in": "path", "description": "The activityLog id.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/bndry.api.risk.entities.v1alpha.ActivityLog" } } } } } } }, "/v1alpha/activityLogs/{activityLog}:undelete": { "post": { "tags": [ "Entities" ], "summary": "Undelete an activity log", "description": "Undeletes a soft-deleted activity log.", "operationId": "EntityService_UndeleteActivityLog", "parameters": [ { "name": "activityLog", "in": "path", "description": "The activityLog id.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/bndry.api.risk.entities.v1alpha.ActivityLog" } } } } } } }, "/v1alpha/entities": { "get": { "tags": [ "Entities" ], "summary": "List all entities", "description": "Lists entities.", "operationId": "EntityService_ListEntities", "parameters": [ { "name": "pageSize", "in": "query", "description": "Optional. The maximum number of entities to return. The service may return fewer than\n this value.\n If unspecified, at most 50 entities will be returned.\n The maximum value is 1000; values above 1000 will be coerced to 1000.", "required": false, "schema": { "type": "integer", "examples": [ 25 ], "title": "page_size", "format": "int32", "description": "(OPTIONAL) Optional. The maximum number of entities to return. The service may return fewer than\n this value.\n If unspecified, at most 50 entities will be returned.\n The maximum value is 1000; values above 1000 will be coerced to 1000." } }, { "name": "pageToken", "in": "query", "description": "Optional. A page token, received from a previous `ListEntities` call.\n Provide this to retrieve the subsequent page.\n When paginating, all other parameters provided to `ListEntities` must\n match the call that provided the page token.", "required": false, "schema": { "type": "string", "examples": [ "ChAIAhABGAE" ], "title": "page_token", "description": "(OPTIONAL) Optional. A page token, received from a previous `ListEntities` call.\n Provide this to retrieve the subsequent page.\n When paginating, all other parameters provided to `ListEntities` must\n match the call that provided the page token." } }, { "name": "showDeleted", "in": "query", "description": "Optional. If true, soft-deleted entities will be included in the response.\n See AIP-164.", "required": false, "schema": { "type": "boolean", "title": "show_deleted", "description": "(OPTIONAL) Optional. If true, soft-deleted entities will be included in the response.\n See AIP-164." } }, { "name": "skip", "in": "query", "description": "Optional. The number of entities to skip before starting to collect the result set.", "required": false, "schema": { "type": "integer", "examples": [ 50 ], "title": "skip", "format": "int32", "description": "(OPTIONAL) Optional. The number of entities to skip before starting to collect the result set." } }, { "name": "filter", "in": "query", "description": "Optional. A filter expression that filters the results listed in the response.\n Filter only currently supports a fuzzy search on display name.\n See AIP-160 for more details.", "required": false, "schema": { "type": "string", "examples": [ "John Smith" ], "title": "filter", "description": "(OPTIONAL) Optional. A filter expression that filters the results listed in the response.\n Filter only currently supports a fuzzy search on display name.\n See AIP-160 for more details." } }, { "name": "orderBy", "in": "query", "required": false, "schema": { "type": "string", "examples": [ "displayName desc" ], "title": "order_by", "description": "(OPTIONAL) " } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/bndry.api.risk.entities.v1alpha.ListEntitiesResponse" } } } } } }, "post": { "tags": [ "Entities" ], "summary": "Create an entity", "description": "Creates a new entity.", "operationId": "EntityService_CreateEntity", "parameters": [ { "name": "entityId", "in": "query", "description": "Optional. The ID to use for the entity, which will become the final component of\n the entity's resource name. This value should be 4-63 characters,\n and valid characters are /[a-z][0-9]-/.", "required": false, "schema": { "type": "string", "examples": [ "john-smith-001" ], "title": "entity_id", "maxLength": 63, "minLength": 4, "description": "(OPTIONAL) Optional. The ID to use for the entity, which will become the final component of\n the entity's resource name. This value should be 4-63 characters,\n and valid characters are /[a-z][0-9]-/." } } ], "requestBody": { "description": "Required. The entity to create.", "content": { "application/json": { "schema": { "title": "entity", "description": "Required. The entity to create.", "$ref": "#/components/schemas/bndry.api.risk.entities.v1alpha.Entity" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/bndry.api.risk.entities.v1alpha.Entity" } } } } } } }, "/v1alpha/entities/{entity}": { "get": { "tags": [ "Entities" ], "summary": "Retrieve an entity", "description": "Retrieves an entity.", "operationId": "EntityService_GetEntity", "parameters": [ { "name": "entity", "in": "path", "description": "The entity id.", "required": true, "schema": { "type": "string" } }, { "name": "system", "in": "query", "description": "Optional. External system identifier for external ID lookup.\n When provided, the entity ID in name is treated as an external ID.", "required": false, "schema": { "type": "string", "examples": [ "salesforce" ], "title": "system", "description": "(OPTIONAL) Optional. External system identifier for external ID lookup.\n When provided, the entity ID in name is treated as an external ID." } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/bndry.api.risk.entities.v1alpha.Entity" } } } } } }, "delete": { "tags": [ "Entities" ], "summary": "Delete an entity", "description": "Soft-deletes an entity.", "operationId": "EntityService_DeleteEntity", "parameters": [ { "name": "entity", "in": "path", "description": "The entity id.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/bndry.api.risk.entities.v1alpha.Entity" } } } } } }, "patch": { "tags": [ "Entities" ], "summary": "Update an entity", "description": "Updates an entity.", "operationId": "EntityService_UpdateEntity", "parameters": [ { "name": "entity", "in": "path", "description": "The entity id.", "required": true, "schema": { "type": "string" } }, { "name": "updateMask", "in": "query", "description": "Optional. The list of fields to be updated.\n\n If not provided (i.e., the mask is omitted), the server will update all\n fields that are populated in the `entity` message in this request\n (i.e., fields that have a non-empty value).\n\n The special value `*` can be used for a full replacement of the resource,\n equivalent to a PUT operation. When using `*`, be cautious as new fields\n added to the resource in the future will also be updated.\n\n For robust updates, explicitly specifying the fields is recommended.\n\n See AIP-134 (Standard Update) and AIP-161 (Field Masks) for more details.", "required": false, "schema": { "type": "string", "description": "`FieldMask` represents a set of symbolic field paths, for example:\n\n paths: \"f.a\"\n paths: \"f.b.d\"\n\n Here `f` represents a field in some root message, `a` and `b`\n fields in the message found in `f`, and `d` a field found in the\n message in `f.b`.\n\n Field masks are used to specify a subset of fields that should be\n returned by a get operation or modified by an update operation.\n Field masks also have a custom JSON encoding (see below).\n\n # Field Masks in Projections\n\n When used in the context of a projection, a response message or\n sub-message is filtered by the API to only contain those fields as\n specified in the mask. For example, if the mask in the previous\n example is applied to a response message as follows:\n\n f {\n a : 22\n b {\n d : 1\n x : 2\n }\n y : 13\n }\n z: 8\n\n The result will not contain specific values for fields x,y and z\n (their value will be set to the default, and omitted in proto text\n output):\n\n\n f {\n a : 22\n b {\n d : 1\n }\n }\n\n A repeated field is not allowed except at the last position of a\n paths string.\n\n If a FieldMask object is not present in a get operation, the\n operation applies to all fields (as if a FieldMask of all fields\n had been specified).\n\n Note that a field mask does not necessarily apply to the\n top-level response message. In case of a REST get operation, the\n field mask applies directly to the response, but in case of a REST\n list operation, the mask instead applies to each individual message\n in the returned resource list. In case of a REST custom method,\n other definitions may be used. Where the mask applies will be\n clearly documented together with its declaration in the API. In\n any case, the effect on the returned resource/resources is required\n behavior for APIs.\n\n # Field Masks in Update Operations\n\n A field mask in update operations specifies which fields of the\n targeted resource are going to be updated. The API is required\n to only change the values of the fields as specified in the mask\n and leave the others untouched. If a resource is passed in to\n describe the updated values, the API ignores the values of all\n fields not covered by the mask.\n\n If a repeated field is specified for an update operation, new values will\n be appended to the existing repeated field in the target resource. Note that\n a repeated field is only allowed in the last position of a `paths` string.\n\n If a sub-message is specified in the last position of the field mask for an\n update operation, then new value will be merged into the existing sub-message\n in the target resource.\n\n For example, given the target message:\n\n f {\n b {\n d: 1\n x: 2\n }\n c: [1]\n }\n\n And an update message:\n\n f {\n b {\n d: 10\n }\n c: [2]\n }\n\n then if the field mask is:\n\n paths: [\"f.b\", \"f.c\"]\n\n then the result will be:\n\n f {\n b {\n d: 10\n x: 2\n }\n c: [1, 2]\n }\n\n An implementation may provide options to override this default behavior for\n repeated and message fields.\n\n In order to reset a field's value to the default, the field must\n be in the mask and set to the default value in the provided resource.\n Hence, in order to reset all fields of a resource, provide a default\n instance of the resource and set all fields in the mask, or do\n not provide a mask as described below.\n\n If a field mask is not present on update, the operation applies to\n all fields (as if a field mask of all fields has been specified).\n Note that in the presence of schema evolution, this may mean that\n fields the client does not know and has therefore not filled into\n the request will be reset to their default. If this is unwanted\n behavior, a specific service may require a client to always specify\n a field mask, producing an error if not.\n\n As with get operations, the location of the resource which\n describes the updated values in the request message depends on the\n operation kind. In any case, the effect of the field mask is\n required to be honored by the API.\n\n ## Considerations for HTTP REST\n\n The HTTP kind of an update operation which uses a field mask must\n be set to PATCH instead of PUT in order to satisfy HTTP semantics\n (PUT must only be used for full updates).\n\n # JSON Encoding of Field Masks\n\n In JSON, a field mask is encoded as a single string where paths are\n separated by a comma. Fields name in each path are converted\n to/from lower-camel naming conventions.\n\n As an example, consider the following message declarations:\n\n message Profile {\n User user = 1;\n Photo photo = 2;\n }\n message User {\n string display_name = 1;\n string address = 2;\n }\n\n In proto a field mask for `Profile` may look as such:\n\n mask {\n paths: \"user.display_name\"\n paths: \"photo\"\n }\n\n In JSON, the same mask is represented as below:\n\n {\n mask: \"user.displayName,photo\"\n }\n\n # Field Masks and Oneof Fields\n\n Field masks treat fields in oneofs just as regular fields. Consider the\n following message:\n\n message SampleMessage {\n oneof test_oneof {\n string name = 4;\n SubMessage sub_message = 9;\n }\n }\n\n The field mask can be:\n\n mask {\n paths: \"name\"\n }\n\n Or:\n\n mask {\n paths: \"sub_message\"\n }\n\n Note that oneof type names (\"test_oneof\" in this case) cannot be used in\n paths.\n\n ## Field Mask Verification\n\n The implementation of any API method which has a FieldMask type field in the\n request should verify the included field paths, and return an\n `INVALID_ARGUMENT` error if any path is unmappable." } } ], "requestBody": { "description": "Required. The entity to update.\n\n The entity's `name` field is used to identify the entity to update.\n Format: entities/{entity}", "content": { "application/json": { "schema": { "title": "entity", "description": "Required. The entity to update.\n\n The entity's `name` field is used to identify the entity to update.\n Format: entities/{entity}", "$ref": "#/components/schemas/bndry.api.risk.entities.v1alpha.Entity" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/bndry.api.risk.entities.v1alpha.Entity" } } } } } } }, "/v1alpha/entities/{entity}/activityLogs": { "get": { "tags": [ "Entities" ], "summary": "List activity logs for an entity", "description": "Lists activities for an entity.", "operationId": "EntityService_ListActivityLogs", "parameters": [ { "name": "entity", "in": "path", "description": "The entity id.", "required": true, "schema": { "type": "string" } }, { "name": "pageSize", "in": "query", "description": "Optional. The maximum number of activities to return. The service may return fewer than\n this value.\n If unspecified, at most 50 activities will be returned.\n The maximum value is 1000; values above 1000 will be coerced to 1000.", "required": false, "schema": { "type": "integer", "examples": [ 25 ], "title": "page_size", "format": "int32", "description": "(OPTIONAL) Optional. The maximum number of activities to return. The service may return fewer than\n this value.\n If unspecified, at most 50 activities will be returned.\n The maximum value is 1000; values above 1000 will be coerced to 1000." } }, { "name": "pageToken", "in": "query", "description": "Optional. A page token, received from a previous `ListEntityActivities` call.\n Provide this to retrieve the subsequent page.\n When paginating, all other parameters provided to `ListEntityActivities` must\n match the call that provided the page token.", "required": false, "schema": { "type": "string", "examples": [ "ChAIAhABGAE" ], "title": "page_token", "description": "(OPTIONAL) Optional. A page token, received from a previous `ListEntityActivities` call.\n Provide this to retrieve the subsequent page.\n When paginating, all other parameters provided to `ListEntityActivities` must\n match the call that provided the page token." } }, { "name": "skip", "in": "query", "description": "Optional. The number of resources to skip over before returning resources.\n Default is 0. See: https://google.aip.dev/158#skipping-results", "required": false, "schema": { "type": "integer", "examples": [ 0 ], "title": "skip", "format": "int32", "description": "(OPTIONAL) Optional. The number of resources to skip over before returning resources.\n Default is 0. See: https://google.aip.dev/158#skipping-results" } }, { "name": "orderBy", "in": "query", "required": false, "schema": { "type": "string", "examples": [ "occurredTime desc" ], "title": "order_by", "description": "(OPTIONAL) " } }, { "name": "filter", "in": "query", "description": "Optional. A filter expression that filters the results listed in the response.", "required": false, "schema": { "type": "string", "title": "filter", "description": "(OPTIONAL) Optional. A filter expression that filters the results listed in the response." } }, { "name": "showDeleted", "in": "query", "description": "Optional. If true, soft-deleted activity logs will be included in the response.\n See AIP-164.", "required": false, "schema": { "type": "boolean", "title": "show_deleted", "description": "(OPTIONAL) Optional. If true, soft-deleted activity logs will be included in the response.\n See AIP-164." } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/bndry.api.risk.entities.v1alpha.ListActivityLogsResponse" } } } } } } }, "/v1alpha/entities/{entity}/files": { "get": { "tags": [ "Entities" ], "summary": "List files for an entity", "operationId": "EntityService_ListFiles", "parameters": [ { "name": "entity", "in": "path", "description": "The entity id.", "required": true, "schema": { "type": "string" } }, { "name": "pageSize", "in": "query", "description": "Optional. The maximum number of files to return. The service may return fewer than\n this value.\n If unspecified, at most 50 entities will be returned.\n The maximum value is 1000; values above 1000 will be coerced to 1000.", "required": false, "schema": { "type": "integer", "examples": [ 25 ], "title": "page_size", "format": "int32", "description": "(OPTIONAL) Optional. The maximum number of files to return. The service may return fewer than\n this value.\n If unspecified, at most 50 entities will be returned.\n The maximum value is 1000; values above 1000 will be coerced to 1000." } }, { "name": "pageToken", "in": "query", "description": "Optional. A page token, received from a previous `ListFiles` call.\n Provide this to retrieve the subsequent page.\n When paginating, all other parameters provided to `ListFiles` must\n match the call that provided the page token.", "required": false, "schema": { "type": "string", "examples": [ "ChAIAhABGAE" ], "title": "page_token", "description": "(OPTIONAL) Optional. A page token, received from a previous `ListFiles` call.\n Provide this to retrieve the subsequent page.\n When paginating, all other parameters provided to `ListFiles` must\n match the call that provided the page token." } }, { "name": "showDeleted", "in": "query", "description": "Optional. If true, soft-deleted files will be included in the response.\n See AIP-164.", "required": false, "schema": { "type": "boolean", "title": "show_deleted", "description": "(OPTIONAL) Optional. If true, soft-deleted files will be included in the response.\n See AIP-164." } }, { "name": "skip", "in": "query", "description": "Optional. The number of files to skip before starting to collect the result set.", "required": false, "schema": { "type": "integer", "examples": [ 50 ], "title": "skip", "format": "int32", "description": "(OPTIONAL) Optional. The number of files to skip before starting to collect the result set." } }, { "name": "filter", "in": "query", "description": "Optional. A filter expression that filters the results listed in the response.\n Filter only currently supports a fuzzy search on display name.\n See AIP-160 for more details.", "required": false, "schema": { "type": "string", "examples": [ "John Smith" ], "title": "filter", "description": "(OPTIONAL) Optional. A filter expression that filters the results listed in the response.\n Filter only currently supports a fuzzy search on display name.\n See AIP-160 for more details." } }, { "name": "orderBy", "in": "query", "required": false, "schema": { "type": "string", "examples": [ "displayName desc" ], "title": "order_by", "description": "(OPTIONAL) " } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/bndry.api.risk.entities.v1alpha.ListFilesResponse" } } } } } }, "post": { "tags": [ "Entities" ], "summary": "Create a file for an entity", "operationId": "EntityService_CreateEntityFile", "parameters": [ { "name": "entity", "in": "path", "description": "The entity id.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Required. The file to create.", "content": { "application/json": { "schema": { "title": "file", "description": "Required. The file to create.", "$ref": "#/components/schemas/bndry.api.datacollection.files.v1alpha.File" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/bndry.api.datacollection.files.v1alpha.File" } } } } } } }, "/v1alpha/entities/{entity}/individualEntityRiskRatingJobs": { "get": { "tags": [ "Entity Risk Rating" ], "summary": "List risk rating jobs", "description": "Lists risk rating jobs for a specific entity.", "operationId": "IndividualEntityRiskRatingJobService_ListIndividualEntityRiskRatingJobs", "parameters": [ { "name": "entity", "in": "path", "description": "The entity id.", "required": true, "schema": { "type": "string" } }, { "name": "pageSize", "in": "query", "description": "Optional. The maximum number of jobs to return. The service may return fewer than\n this value.\n If unspecified, at most 10 jobs will be returned.\n The maximum value is 100; values above 100 will be coerced to 100.", "required": false, "schema": { "type": "integer", "examples": [ 25 ], "title": "page_size", "format": "int32", "description": "(OPTIONAL) Optional. The maximum number of jobs to return. The service may return fewer than\n this value.\n If unspecified, at most 10 jobs will be returned.\n The maximum value is 100; values above 100 will be coerced to 100." } }, { "name": "pageToken", "in": "query", "description": "Optional. A page token, received from a previous `ListIndividualEntityRiskRatingJobs` call.\n Provide this to retrieve the subsequent page.\n When paginating, all other parameters provided to `ListIndividualEntityRiskRatingJobs` must\n match the call that provided the page token.", "required": false, "schema": { "type": "string", "examples": [ "ChAIAhABGAEiAggC" ], "title": "page_token", "description": "(OPTIONAL) Optional. A page token, received from a previous `ListIndividualEntityRiskRatingJobs` call.\n Provide this to retrieve the subsequent page.\n When paginating, all other parameters provided to `ListIndividualEntityRiskRatingJobs` must\n match the call that provided the page token." } }, { "name": "skip", "in": "query", "description": "Optional. The number of jobs to skip before starting to collect the result set.", "required": false, "schema": { "type": "integer", "examples": [ 0 ], "title": "skip", "minimum": 0, "format": "int32", "description": "(OPTIONAL) Optional. The number of jobs to skip before starting to collect the result set." } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/bndry.api.risk.entities.v1alpha.ListIndividualEntityRiskRatingJobsResponse" } } } } } }, "post": { "tags": [ "Entity Risk Rating" ], "summary": "Create a risk rating job", "description": "Creates a new risk rating job.", "operationId": "IndividualEntityRiskRatingJobService_CreateIndividualEntityRiskRatingJob", "parameters": [ { "name": "entity", "in": "path", "description": "The entity id.", "required": true, "schema": { "type": "string" } }, { "name": "individualEntityRiskRatingJobId", "in": "query", "description": "REQUIRED. The ID to use for the job, which will become the final component of\n the job's resource name. This value should be 4-63 characters,\n and valid characters are /[a-z][0-9]-/.", "required": true, "schema": { "type": "string", "examples": [ "pep-sanction-screen-001" ], "title": "individual_entity_risk_rating_job_id", "maxLength": 63, "minLength": 4, "description": "REQUIRED. The ID to use for the job, which will become the final component of\n the job's resource name. This value should be 4-63 characters,\n and valid characters are /[a-z][0-9]-/." } } ], "requestBody": { "description": "Required. The risk rating job to create.", "content": { "application/json": { "schema": { "title": "individual_entity_risk_rating_job", "description": "Required. The risk rating job to create.", "$ref": "#/components/schemas/bndry.api.risk.entities.v1alpha.IndividualEntityRiskRatingJob" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/bndry.api.risk.entities.v1alpha.IndividualEntityRiskRatingJob" } } } } } } }, "/v1alpha/entities/{entity}/individualEntityRiskRatingJobs/{individualEntityRiskRatingJob}": { "get": { "tags": [ "Entity Risk Rating" ], "summary": "Retrieve a risk rating job", "description": "Retrieves details about a specific risk rating job.", "operationId": "IndividualEntityRiskRatingJobService_GetIndividualEntityRiskRatingJob", "parameters": [ { "name": "entity", "in": "path", "description": "The entity id.", "required": true, "schema": { "type": "string" } }, { "name": "individualEntityRiskRatingJob", "in": "path", "description": "The individualEntityRiskRatingJob id.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/bndry.api.risk.entities.v1alpha.IndividualEntityRiskRatingJob" } } } } } } }, "/v1alpha/entities/{entity}/individualEntityRiskRatingJobs/{individualEntityRiskRatingJob}/operations/{operation}": { "get": { "tags": [ "Entity Risk Rating" ], "summary": "GetOperation", "description": "Gets the latest state of a long-running operation. Clients can use this\n method to poll the operation result at intervals as recommended by the API\n service.", "operationId": "IndividualEntityRiskRatingJobService_GetOperation", "parameters": [ { "name": "entity", "in": "path", "description": "The entity id.", "required": true, "schema": { "type": "string" } }, { "name": "individualEntityRiskRatingJob", "in": "path", "description": "The individualEntityRiskRatingJob id.", "required": true, "schema": { "type": "string" } }, { "name": "operation", "in": "path", "description": "The operation id.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/google.longrunning.Operation" } } } } } } }, "/v1alpha/entities/{entity}/individualEntityRiskRatingJobs/{individualEntityRiskRatingJob}:run": { "post": { "tags": [ "Entity Risk Rating" ], "summary": "Run a risk rating job", "description": "Runs a risk rating job.", "operationId": "IndividualEntityRiskRatingJobService_RunIndividualEntityRiskRatingJob", "parameters": [ { "name": "entity", "in": "path", "description": "The entity id.", "required": true, "schema": { "type": "string" } }, { "name": "individualEntityRiskRatingJob", "in": "path", "description": "The individualEntityRiskRatingJob id.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/google.longrunning.Operation" } } } } } } }, "/v1alpha/entities/{entity}/onboardIndividualEntityJobs": { "get": { "tags": [ "Onboard Individual Entity" ], "summary": "List onboard individual entity jobs", "description": "Lists onboard individual entity jobs for a specific entity.", "operationId": "OnboardIndividualEntityJobService_ListOnboardIndividualEntityJobs", "parameters": [ { "name": "entity", "in": "path", "description": "The entity id.", "required": true, "schema": { "type": "string" } }, { "name": "pageSize", "in": "query", "description": "Optional. The maximum number of jobs to return. The service may return fewer than\n this value.\n If unspecified, at most 10 jobs will be returned.\n The maximum value is 100; values above 100 will be coerced to 100.", "required": false, "schema": { "type": "integer", "examples": [ 25 ], "title": "page_size", "format": "int32", "description": "(OPTIONAL) Optional. The maximum number of jobs to return. The service may return fewer than\n this value.\n If unspecified, at most 10 jobs will be returned.\n The maximum value is 100; values above 100 will be coerced to 100." } }, { "name": "pageToken", "in": "query", "description": "Optional. A page token, received from a previous `ListOnboardIndividualEntityJobs` call.\n Provide this to retrieve the subsequent page.\n When paginating, all other parameters provided to `ListOnboardIndividualEntityJobs` must\n match the call that provided the page token.", "required": false, "schema": { "type": "string", "examples": [ "ChAIAhABGAEiAggC" ], "title": "page_token", "description": "(OPTIONAL) Optional. A page token, received from a previous `ListOnboardIndividualEntityJobs` call.\n Provide this to retrieve the subsequent page.\n When paginating, all other parameters provided to `ListOnboardIndividualEntityJobs` must\n match the call that provided the page token." } }, { "name": "skip", "in": "query", "description": "Optional. The number of jobs to skip before starting to collect the result set.", "required": false, "schema": { "type": "integer", "examples": [ 0 ], "title": "skip", "minimum": 0, "format": "int32", "description": "(OPTIONAL) Optional. The number of jobs to skip before starting to collect the result set." } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/bndry.api.risk.entities.v1alpha.ListOnboardIndividualEntityJobsResponse" } } } } } }, "post": { "tags": [ "Onboard Individual Entity" ], "summary": "Create an onboard individual entity job", "description": "Creates a new onboard individual entity job.", "operationId": "OnboardIndividualEntityJobService_CreateOnboardIndividualEntityJob", "parameters": [ { "name": "entity", "in": "path", "description": "The entity id.", "required": true, "schema": { "type": "string" } }, { "name": "onboardIndividualEntityJobId", "in": "query", "description": "REQUIRED. The ID to use for the job, which will become the final component of\n the job's resource name. This value should be 4-63 characters,\n and valid characters are /[a-z][0-9]-/.", "required": true, "schema": { "type": "string", "examples": [ "kyc-individual-mfs-001" ], "title": "onboard_individual_entity_job_id", "maxLength": 63, "minLength": 4, "description": "REQUIRED. The ID to use for the job, which will become the final component of\n the job's resource name. This value should be 4-63 characters,\n and valid characters are /[a-z][0-9]-/." } } ], "requestBody": { "description": "Required. The onboard individual entity job to create.", "content": { "application/json": { "schema": { "title": "onboard_individual_entity_job", "description": "Required. The onboard individual entity job to create.", "$ref": "#/components/schemas/bndry.api.risk.entities.v1alpha.OnboardIndividualEntityJob" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/bndry.api.risk.entities.v1alpha.OnboardIndividualEntityJob" } } } } } } }, "/v1alpha/entities/{entity}/onboardIndividualEntityJobs/{onboardIndividualEntityJob}": { "get": { "tags": [ "Onboard Individual Entity" ], "summary": "Retrieve an onboard individual entity job", "description": "Retrieves details about a specific onboard individual entity job.", "operationId": "OnboardIndividualEntityJobService_GetOnboardIndividualEntityJob", "parameters": [ { "name": "entity", "in": "path", "description": "The entity id.", "required": true, "schema": { "type": "string" } }, { "name": "onboardIndividualEntityJob", "in": "path", "description": "The onboardIndividualEntityJob id.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/bndry.api.risk.entities.v1alpha.OnboardIndividualEntityJob" } } } } } } }, "/v1alpha/entities/{entity}/onboardIndividualEntityJobs/{onboardIndividualEntityJob}/operations/{operation}": { "get": { "tags": [ "Onboard Individual Entity" ], "summary": "GetOperation", "description": "Gets the latest state of a long-running operation. Clients can use this\n method to poll the operation result at intervals as recommended by the API\n service.", "operationId": "OnboardIndividualEntityJobService_GetOperation", "parameters": [ { "name": "entity", "in": "path", "description": "The entity id.", "required": true, "schema": { "type": "string" } }, { "name": "onboardIndividualEntityJob", "in": "path", "description": "The onboardIndividualEntityJob id.", "required": true, "schema": { "type": "string" } }, { "name": "operation", "in": "path", "description": "The operation id.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/google.longrunning.Operation" } } } } } } }, "/v1alpha/entities/{entity}/onboardIndividualEntityJobs/{onboardIndividualEntityJob}:run": { "post": { "tags": [ "Onboard Individual Entity" ], "summary": "Run an onboard individual entity job", "description": "Runs an onboard individual entity job.", "operationId": "OnboardIndividualEntityJobService_RunOnboardIndividualEntityJob", "parameters": [ { "name": "entity", "in": "path", "description": "The entity id.", "required": true, "schema": { "type": "string" } }, { "name": "onboardIndividualEntityJob", "in": "path", "description": "The onboardIndividualEntityJob id.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "redirectUri": { "type": "string", "examples": [ "https://app.example.com/kyc/complete" ], "title": "redirect_uri", "format": "uri", "description": "The final redirect URI where the user should be sent after onboarding is complete." }, "entityAnnotations": { "type": "object", "title": "entity_annotations", "additionalProperties": { "type": "string", "title": "value" }, "description": "(OPTIONAL) Optional. Arbitrary annotations to be applied to the entity being created." } }, "title": "RunOnboardIndividualEntityJobRequest", "required": [ "redirectUri" ], "additionalProperties": false, "description": "Request message for [RunOnboardIndividualEntityJob][bndry.api.risk.entities.v1alpha.OnboardIndividualEntityJobService.RunOnboardIndividualEntityJob]." } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/google.longrunning.Operation" } } } } } } }, "/v1alpha/entities/{entity}/pepSanctionIndividualEntityJobs": { "get": { "tags": [ "Entity PEP Sanctions Check" ], "summary": "List PEP and sanctions screening jobs", "description": "Lists PEP and sanctions screening jobs for a specific entity.", "operationId": "PepSanctionIndividualEntityJobService_ListPepSanctionIndividualEntityJobs", "parameters": [ { "name": "entity", "in": "path", "description": "The entity id.", "required": true, "schema": { "type": "string" } }, { "name": "pageSize", "in": "query", "description": "Optional. The maximum number of jobs to return. The service may return fewer than\n this value.\n If unspecified, at most 10 jobs will be returned.\n The maximum value is 100; values above 100 will be coerced to 100.", "required": false, "schema": { "type": "integer", "examples": [ 25 ], "title": "page_size", "format": "int32", "description": "(OPTIONAL) Optional. The maximum number of jobs to return. The service may return fewer than\n this value.\n If unspecified, at most 10 jobs will be returned.\n The maximum value is 100; values above 100 will be coerced to 100." } }, { "name": "pageToken", "in": "query", "description": "Optional. A page token, received from a previous `ListPepSanctionIndividualEntityJobs` call.\n Provide this to retrieve the subsequent page.\n When paginating, all other parameters provided to `ListPepSanctionIndividualEntityJobs` must\n match the call that provided the page token.", "required": false, "schema": { "type": "string", "examples": [ "ChAIAhABGAEiAggC" ], "title": "page_token", "description": "(OPTIONAL) Optional. A page token, received from a previous `ListPepSanctionIndividualEntityJobs` call.\n Provide this to retrieve the subsequent page.\n When paginating, all other parameters provided to `ListPepSanctionIndividualEntityJobs` must\n match the call that provided the page token." } }, { "name": "skip", "in": "query", "description": "Optional. The number of jobs to skip before starting to collect the result set.", "required": false, "schema": { "type": "integer", "examples": [ 0 ], "title": "skip", "minimum": 0, "format": "int32", "description": "(OPTIONAL) Optional. The number of jobs to skip before starting to collect the result set." } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/bndry.api.risk.entities.v1alpha.ListPepSanctionIndividualEntityJobsResponse" } } } } } }, "post": { "tags": [ "Entity PEP Sanctions Check" ], "summary": "Create a PEP and sanctions screening job", "description": "Creates a new PEP and sanctions screening job.", "operationId": "PepSanctionIndividualEntityJobService_CreatePepSanctionIndividualEntityJob", "parameters": [ { "name": "entity", "in": "path", "description": "The entity id.", "required": true, "schema": { "type": "string" } }, { "name": "pepSanctionIndividualEntityJobId", "in": "query", "description": "REQUIRED. The ID to use for the job, which will become the final component of\n the job's resource name. This value should be 4-63 characters,\n and valid characters are /[a-z][0-9]-/.", "required": true, "schema": { "type": "string", "examples": [ "pep-sanction-screen-001" ], "title": "pep_sanction_individual_entity_job_id", "maxLength": 63, "minLength": 4, "description": "REQUIRED. The ID to use for the job, which will become the final component of\n the job's resource name. This value should be 4-63 characters,\n and valid characters are /[a-z][0-9]-/." } } ], "requestBody": { "description": "Required. The PEP and sanctions screening job to create.", "content": { "application/json": { "schema": { "title": "pep_sanction_individual_entity_job", "description": "Required. The PEP and sanctions screening job to create.", "$ref": "#/components/schemas/bndry.api.risk.entities.v1alpha.PepSanctionIndividualEntityJob" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/bndry.api.risk.entities.v1alpha.PepSanctionIndividualEntityJob" } } } } } } }, "/v1alpha/entities/{entity}/pepSanctionIndividualEntityJobs/{pepSanctionIndividualEntityJob}": { "get": { "tags": [ "Entity PEP Sanctions Check" ], "summary": "Retrieve a PEP and sanctions screening job", "description": "Retrieves details about a specific PEP and sanctions screening job.", "operationId": "PepSanctionIndividualEntityJobService_GetPepSanctionIndividualEntityJob", "parameters": [ { "name": "entity", "in": "path", "description": "The entity id.", "required": true, "schema": { "type": "string" } }, { "name": "pepSanctionIndividualEntityJob", "in": "path", "description": "The pepSanctionIndividualEntityJob id.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/bndry.api.risk.entities.v1alpha.PepSanctionIndividualEntityJob" } } } } } } }, "/v1alpha/entities/{entity}/pepSanctionIndividualEntityJobs/{pepSanctionIndividualEntityJob}/operations/{operation}": { "get": { "tags": [ "Entity PEP Sanctions Check" ], "summary": "GetOperation", "description": "Gets the latest state of a long-running operation. Clients can use this\n method to poll the operation result at intervals as recommended by the API\n service.", "operationId": "PepSanctionIndividualEntityJobService_GetOperation", "parameters": [ { "name": "entity", "in": "path", "description": "The entity id.", "required": true, "schema": { "type": "string" } }, { "name": "pepSanctionIndividualEntityJob", "in": "path", "description": "The pepSanctionIndividualEntityJob id.", "required": true, "schema": { "type": "string" } }, { "name": "operation", "in": "path", "description": "The operation id.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/google.longrunning.Operation" } } } } } } }, "/v1alpha/entities/{entity}/pepSanctionIndividualEntityJobs/{pepSanctionIndividualEntityJob}:run": { "post": { "tags": [ "Entity PEP Sanctions Check" ], "summary": "Run a PEP and sanctions screening job", "description": "Runs a PEP and sanctions screening job.", "operationId": "PepSanctionIndividualEntityJobService_RunPepSanctionIndividualEntityJob", "parameters": [ { "name": "entity", "in": "path", "description": "The entity id.", "required": true, "schema": { "type": "string" } }, { "name": "pepSanctionIndividualEntityJob", "in": "path", "description": "The pepSanctionIndividualEntityJob id.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/google.longrunning.Operation" } } } } } } }, "/v1alpha/entities/{entity}:EntityRelationships": { "get": { "tags": [ "Entities" ], "summary": "View entity relationships", "operationId": "EntityService_ViewEntityRelationships", "parameters": [ { "name": "entity", "in": "path", "description": "The entity id.", "required": true, "schema": { "type": "string" } }, { "name": "view", "in": "query", "required": false, "schema": { "title": "view", "description": "(OPTIONAL) ", "$ref": "#/components/schemas/bndry.api.risk.entities.v1alpha.RelationshipView" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/bndry.api.risk.entities.v1alpha.ViewEntityRelationshipsResponse" } } } } } } }, "/v1alpha/entities/{entity}:addEntityRelationship": { "post": { "tags": [ "Entities" ], "summary": "Add an entity relationship", "operationId": "EntityService_AddEntityRelationship", "parameters": [ { "name": "entity", "in": "path", "description": "The entity id.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "targetEntity": { "type": "string", "examples": [ "entities/example-financial-services" ], "title": "target_entity", "description": "correct_name_format // name must start with 'entities/'\n" }, "relationshipType": { "title": "relationship_type", "$ref": "#/components/schemas/bndry.api.risk.entities.v1alpha.RelationshipType" } }, "title": "AddEntityRelationshipRequest", "required": [ "targetEntity", "relationshipType" ], "additionalProperties": false } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/bndry.api.risk.entities.v1alpha.Entity" } } } } } } }, "/v1alpha/entities/{entity}:addTag": { "post": { "tags": [ "Entities" ], "summary": "Add a tag to an entity", "description": "Adds a tag to an entity.", "operationId": "EntityService_AddTag", "parameters": [ { "name": "entity", "in": "path", "description": "The entity id.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "tag": { "title": "tag", "description": "Required. The tag to add to the entity.", "$ref": "#/components/schemas/bndry.api.risk.entities.v1alpha.Tag" } }, "title": "AddTagRequest", "required": [ "tag" ], "additionalProperties": false, "description": "Request message for [bndry.api.risk.v1alpha.EntityService.AddTag]." } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/bndry.api.risk.entities.v1alpha.Entity" } } } } } } }, "/v1alpha/entities/{entity}:evaluate": { "post": { "tags": [ "Entities" ], "summary": "Evaluate entity against the Entity Risk Rating rules", "operationId": "EntityService_EvaluateEntity", "parameters": [ { "name": "entity", "in": "path", "description": "The entity id.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/bndry.api.risk.entities.v1alpha.EvaluateEntityResponse" } } } } } } }, "/v1alpha/entities/{entity}:evaluationInput": { "get": { "tags": [ "Entities" ], "summary": "Get the entity input run against risk rating rules", "operationId": "EntityService_GetEntityEvaluationInput", "parameters": [ { "name": "entity", "in": "path", "description": "The entity id.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/bndry.api.risk.entities.v1alpha.GetEntityEvaluationInputResponse" } } } } } } }, "/v1alpha/entities/{entity}:hardDelete": { "delete": { "tags": [ "Entities" ], "summary": "Hard Delete an entity", "description": "Hard-deletes an entity.", "operationId": "EntityService_HardDeleteEntity", "parameters": [ { "name": "entity", "in": "path", "description": "The entity id.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/bndry.api.risk.entities.v1alpha.Entity" } } } } }, "x-internal": true } }, "/v1alpha/entities/{entity}:removeEntityRelationship": { "post": { "tags": [ "Entities" ], "summary": "Remove an entity relationship", "operationId": "EntityService_RemoveEntityRelationship", "parameters": [ { "name": "entity", "in": "path", "description": "The entity id.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "targetEntity": { "type": "string", "examples": [ "entities/john-smith-001" ], "title": "target_entity", "description": "correct_name_format // name must start with 'entities/'\n" }, "relationshipType": { "title": "relationship_type", "$ref": "#/components/schemas/bndry.api.risk.entities.v1alpha.RelationshipType" } }, "title": "RemoveEntityRelationshipRequest", "required": [ "targetEntity", "relationshipType" ], "additionalProperties": false } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/bndry.api.risk.entities.v1alpha.Entity" } } } } } } }, "/v1alpha/entities/{entity}:removeTag": { "post": { "tags": [ "Entities" ], "summary": "Remove a tag from an entity", "description": "Removes a tag from an entity.", "operationId": "EntityService_RemoveTag", "parameters": [ { "name": "entity", "in": "path", "description": "The entity id.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "tag": { "title": "tag", "description": "Required. The tag to remove from the entity.", "$ref": "#/components/schemas/bndry.api.risk.entities.v1alpha.Tag" } }, "title": "RemoveTagRequest", "required": [ "tag" ], "additionalProperties": false, "description": "Request message for [bndry.api.risk.v1alpha.EntityService.RemoveTag]." } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/bndry.api.risk.entities.v1alpha.Entity" } } } } } } }, "/v1alpha/entities/{entity}:undelete": { "post": { "tags": [ "Entities" ], "summary": "Undelete an entity", "description": "Undeletes a soft-deleted entity.", "operationId": "EntityService_UndeleteEntity", "parameters": [ { "name": "entity", "in": "path", "description": "The entity id.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/bndry.api.risk.entities.v1alpha.Entity" } } } } } } }, "/v1alpha/forms": { "get": { "tags": [ "Forms" ], "summary": "List all forms", "description": "List all forms.", "operationId": "FormService_ListForms", "parameters": [ { "name": "parent", "in": "query", "description": "Required. The parent workspace for which to list forms.\n Format: forms/\n Format: workspaces/{workspace}", "required": true, "schema": { "type": "string", "examples": [ "workspaces/aml-monitoring-ws-456" ], "title": "parent", "description": "Required. The parent workspace for which to list forms.\n Format: forms/\n Format: workspaces/{workspace}" } }, { "name": "pageSize", "in": "query", "description": "Optional. The maximum number of forms to return. The service may return fewer than\n this value.\n If unspecified, at most 50 forms will be returned.\n The maximum value is 1000; values above 1000 will be coerced to 1000.", "required": false, "schema": { "type": "integer", "title": "page_size", "format": "int32", "description": "(OPTIONAL) Optional. The maximum number of forms to return. The service may return fewer than\n this value.\n If unspecified, at most 50 forms will be returned.\n The maximum value is 1000; values above 1000 will be coerced to 1000." } }, { "name": "pageToken", "in": "query", "description": "Optional. A page token, received from a previous `ListWorkspaceForms` call.\n Provide this to retrieve the subsequent page.\n When paginating, all other parameters provided to `ListWorkspaceForms` must\n match the call that provided the page token.", "required": false, "schema": { "type": "string", "title": "page_token", "description": "(OPTIONAL) Optional. A page token, received from a previous `ListWorkspaceForms` call.\n Provide this to retrieve the subsequent page.\n When paginating, all other parameters provided to `ListWorkspaceForms` must\n match the call that provided the page token." } }, { "name": "skip", "in": "query", "description": "Optional. The number of forms to skip before starting to collect the result set.", "required": false, "schema": { "type": "integer", "title": "skip", "format": "int32", "description": "(OPTIONAL) Optional. The number of forms to skip before starting to collect the result set." } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/bndry.api.datacollection.forms.v1alpha.ListFormsResponse" } } } } } }, "post": { "tags": [ "Forms" ], "summary": "Create a form", "description": "Creates a form.", "operationId": "FormService_CreateForm", "parameters": [ { "name": "formId", "in": "query", "required": false, "schema": { "type": "string", "examples": [ "compliance-form-202412-001" ], "title": "form_id", "description": "(OPTIONAL) " } } ], "requestBody": { "content": { "application/json": { "schema": { "title": "form", "$ref": "#/components/schemas/bndry.api.datacollection.forms.v1alpha.Form" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/bndry.api.datacollection.forms.v1alpha.Form" } } } } } } }, "/v1alpha/forms/{form}": { "get": { "tags": [ "Forms" ], "summary": "Retrieve a form", "description": "Retrieves a form.", "operationId": "FormService_GetForm", "parameters": [ { "name": "form", "in": "path", "description": "The form id.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/bndry.api.datacollection.forms.v1alpha.Form" } } } } } }, "patch": { "tags": [ "Forms" ], "summary": "Update a form", "description": "Updates a form.", "operationId": "FormService_UpdateForm", "parameters": [ { "name": "form", "in": "path", "description": "The form id.", "required": true, "schema": { "type": "string" } }, { "name": "updateMask", "in": "query", "description": "Optional. The list of fields to be updated.\n\n If not provided (i.e., the mask is omitted), the server will update all\n fields that are populated in the `workspace_form` message in this request\n (i.e., fields that have a non-empty value).\n\n The special value `*` can be used for a full replacement of the resource,\n equivalent to a PUT operation. When using `*`, be cautious as new fields\n added to the resource in the future will also be updated.\n\n For robust updates, explicitly specifying the fields is recommended.\n\n See AIP-134 (Standard Update) and AIP-161 (Field Masks) for more details.", "required": false, "schema": { "type": "string", "description": "`FieldMask` represents a set of symbolic field paths, for example:\n\n paths: \"f.a\"\n paths: \"f.b.d\"\n\n Here `f` represents a field in some root message, `a` and `b`\n fields in the message found in `f`, and `d` a field found in the\n message in `f.b`.\n\n Field masks are used to specify a subset of fields that should be\n returned by a get operation or modified by an update operation.\n Field masks also have a custom JSON encoding (see below).\n\n # Field Masks in Projections\n\n When used in the context of a projection, a response message or\n sub-message is filtered by the API to only contain those fields as\n specified in the mask. For example, if the mask in the previous\n example is applied to a response message as follows:\n\n f {\n a : 22\n b {\n d : 1\n x : 2\n }\n y : 13\n }\n z: 8\n\n The result will not contain specific values for fields x,y and z\n (their value will be set to the default, and omitted in proto text\n output):\n\n\n f {\n a : 22\n b {\n d : 1\n }\n }\n\n A repeated field is not allowed except at the last position of a\n paths string.\n\n If a FieldMask object is not present in a get operation, the\n operation applies to all fields (as if a FieldMask of all fields\n had been specified).\n\n Note that a field mask does not necessarily apply to the\n top-level response message. In case of a REST get operation, the\n field mask applies directly to the response, but in case of a REST\n list operation, the mask instead applies to each individual message\n in the returned resource list. In case of a REST custom method,\n other definitions may be used. Where the mask applies will be\n clearly documented together with its declaration in the API. In\n any case, the effect on the returned resource/resources is required\n behavior for APIs.\n\n # Field Masks in Update Operations\n\n A field mask in update operations specifies which fields of the\n targeted resource are going to be updated. The API is required\n to only change the values of the fields as specified in the mask\n and leave the others untouched. If a resource is passed in to\n describe the updated values, the API ignores the values of all\n fields not covered by the mask.\n\n If a repeated field is specified for an update operation, new values will\n be appended to the existing repeated field in the target resource. Note that\n a repeated field is only allowed in the last position of a `paths` string.\n\n If a sub-message is specified in the last position of the field mask for an\n update operation, then new value will be merged into the existing sub-message\n in the target resource.\n\n For example, given the target message:\n\n f {\n b {\n d: 1\n x: 2\n }\n c: [1]\n }\n\n And an update message:\n\n f {\n b {\n d: 10\n }\n c: [2]\n }\n\n then if the field mask is:\n\n paths: [\"f.b\", \"f.c\"]\n\n then the result will be:\n\n f {\n b {\n d: 10\n x: 2\n }\n c: [1, 2]\n }\n\n An implementation may provide options to override this default behavior for\n repeated and message fields.\n\n In order to reset a field's value to the default, the field must\n be in the mask and set to the default value in the provided resource.\n Hence, in order to reset all fields of a resource, provide a default\n instance of the resource and set all fields in the mask, or do\n not provide a mask as described below.\n\n If a field mask is not present on update, the operation applies to\n all fields (as if a field mask of all fields has been specified).\n Note that in the presence of schema evolution, this may mean that\n fields the client does not know and has therefore not filled into\n the request will be reset to their default. If this is unwanted\n behavior, a specific service may require a client to always specify\n a field mask, producing an error if not.\n\n As with get operations, the location of the resource which\n describes the updated values in the request message depends on the\n operation kind. In any case, the effect of the field mask is\n required to be honored by the API.\n\n ## Considerations for HTTP REST\n\n The HTTP kind of an update operation which uses a field mask must\n be set to PATCH instead of PUT in order to satisfy HTTP semantics\n (PUT must only be used for full updates).\n\n # JSON Encoding of Field Masks\n\n In JSON, a field mask is encoded as a single string where paths are\n separated by a comma. Fields name in each path are converted\n to/from lower-camel naming conventions.\n\n As an example, consider the following message declarations:\n\n message Profile {\n User user = 1;\n Photo photo = 2;\n }\n message User {\n string display_name = 1;\n string address = 2;\n }\n\n In proto a field mask for `Profile` may look as such:\n\n mask {\n paths: \"user.display_name\"\n paths: \"photo\"\n }\n\n In JSON, the same mask is represented as below:\n\n {\n mask: \"user.displayName,photo\"\n }\n\n # Field Masks and Oneof Fields\n\n Field masks treat fields in oneofs just as regular fields. Consider the\n following message:\n\n message SampleMessage {\n oneof test_oneof {\n string name = 4;\n SubMessage sub_message = 9;\n }\n }\n\n The field mask can be:\n\n mask {\n paths: \"name\"\n }\n\n Or:\n\n mask {\n paths: \"sub_message\"\n }\n\n Note that oneof type names (\"test_oneof\" in this case) cannot be used in\n paths.\n\n ## Field Mask Verification\n\n The implementation of any API method which has a FieldMask type field in the\n request should verify the included field paths, and return an\n `INVALID_ARGUMENT` error if any path is unmappable." } } ], "requestBody": { "description": "Required. The form to update.\n\n The form's `name` field is used to identify the form to update.\n Format: forms/{form}\n Format: workspaces/{workspace}/forms/{form}", "content": { "application/json": { "schema": { "title": "form", "description": "Required. The form to update.\n\n The form's `name` field is used to identify the form to update.\n Format: forms/{form}\n Format: workspaces/{workspace}/forms/{form}", "$ref": "#/components/schemas/bndry.api.datacollection.forms.v1alpha.Form" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/bndry.api.datacollection.forms.v1alpha.Form" } } } } } } }, "/v1alpha/forms/{form}/files": { "get": { "tags": [ "Forms" ], "summary": "List files for a form", "description": "Lists form files.", "operationId": "FormService_ListFormFiles", "parameters": [ { "name": "form", "in": "path", "description": "The form id.", "required": true, "schema": { "type": "string" } }, { "name": "pageSize", "in": "query", "description": "Optional. The maximum number of forms to return. The service may return fewer than\n this value.\n If unspecified, at most 50 entities will be returned.\n The maximum value is 1000; values above 1000 will be coerced to 1000.", "required": false, "schema": { "type": "integer", "examples": [ 25 ], "title": "page_size", "format": "int32", "description": "(OPTIONAL) Optional. The maximum number of forms to return. The service may return fewer than\n this value.\n If unspecified, at most 50 entities will be returned.\n The maximum value is 1000; values above 1000 will be coerced to 1000." } }, { "name": "pageToken", "in": "query", "description": "Optional. A page token, received from a previous `ListForms` call.\n Provide this to retrieve the subsequent page.\n When paginating, all other parameters provided to `ListForms` must\n match the call that provided the page token.", "required": false, "schema": { "type": "string", "examples": [ "ChAIAhABGAE" ], "title": "page_token", "description": "(OPTIONAL) Optional. A page token, received from a previous `ListForms` call.\n Provide this to retrieve the subsequent page.\n When paginating, all other parameters provided to `ListForms` must\n match the call that provided the page token." } }, { "name": "showDeleted", "in": "query", "description": "Optional. If true, soft-deleted forms will be included in the response.\n See AIP-164.", "required": false, "schema": { "type": "boolean", "title": "show_deleted", "description": "(OPTIONAL) Optional. If true, soft-deleted forms will be included in the response.\n See AIP-164." } }, { "name": "skip", "in": "query", "description": "Optional. The number of forms to skip before starting to collect the result set.", "required": false, "schema": { "type": "integer", "examples": [ 50 ], "title": "skip", "format": "int32", "description": "(OPTIONAL) Optional. The number of forms to skip before starting to collect the result set." } }, { "name": "orderBy", "in": "query", "required": false, "schema": { "type": "string", "examples": [ "name desc" ], "title": "order_by", "description": "(OPTIONAL) " } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/bndry.api.datacollection.forms.v1alpha.ListFormFilesResponse" } } } } } }, "post": { "tags": [ "Forms" ], "summary": "Create a form file", "description": "Creates form file.", "operationId": "FormService_CreateFormFile", "parameters": [ { "name": "form", "in": "path", "description": "The form id.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Required. The file to create.", "content": { "application/json": { "schema": { "title": "file", "description": "Required. The file to create.", "$ref": "#/components/schemas/bndry.api.datacollection.files.v1alpha.File" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/bndry.api.datacollection.files.v1alpha.File" } } } } } } }, "/v1alpha/forms/{form}:submit": { "post": { "tags": [ "Forms" ], "summary": "Submit a form", "description": "Submits a form.", "operationId": "FormService_SubmitForm", "parameters": [ { "name": "form", "in": "path", "description": "The form id.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/bndry.api.datacollection.forms.v1alpha.SubmitFormResponse" } } } } } } }, "/v1alpha/individualEntityVerificationJobs": { "get": { "tags": [ "Individual Entity Verification" ], "summary": "List individual entity verification jobs", "description": "Lists individual entity verification jobs for a specific entity.", "operationId": "IndividualEntityVerificationJobService_ListIndividualEntityVerificationJobs", "parameters": [ { "name": "pageSize", "in": "query", "description": "Optional. The maximum number of jobs to return. The service may return fewer than\n this value.\n If unspecified, at most 10 jobs will be returned.\n The maximum value is 100; values above 100 will be coerced to 100.", "required": false, "schema": { "type": "integer", "examples": [ 25 ], "title": "page_size", "format": "int32", "description": "(OPTIONAL) Optional. The maximum number of jobs to return. The service may return fewer than\n this value.\n If unspecified, at most 10 jobs will be returned.\n The maximum value is 100; values above 100 will be coerced to 100." } }, { "name": "pageToken", "in": "query", "description": "Optional. A page token, received from a previous `ListIndividualEntityVerificationJobs` call.\n Provide this to retrieve the subsequent page.\n When paginating, all other parameters provided to `ListIndividualEntityVerificationJobs` must\n match the call that provided the page token.", "required": false, "schema": { "type": "string", "examples": [ "ChAIAhABGAEiAggC" ], "title": "page_token", "description": "(OPTIONAL) Optional. A page token, received from a previous `ListIndividualEntityVerificationJobs` call.\n Provide this to retrieve the subsequent page.\n When paginating, all other parameters provided to `ListIndividualEntityVerificationJobs` must\n match the call that provided the page token." } }, { "name": "skip", "in": "query", "description": "Optional. The number of jobs to skip before starting to collect the result set.", "required": false, "schema": { "type": "integer", "examples": [ 0 ], "title": "skip", "minimum": 0, "format": "int32", "description": "(OPTIONAL) Optional. The number of jobs to skip before starting to collect the result set." } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/bndry.api.risk.entities.v1alpha.ListIndividualEntityVerificationJobsResponse" } } } } } }, "post": { "tags": [ "Individual Entity Verification" ], "summary": "Create an individual entity verification job", "description": "Creates a new individual entity verification job.", "operationId": "IndividualEntityVerificationJobService_CreateIndividualEntityVerificationJob", "parameters": [ { "name": "individualEntityVerificationJobId", "in": "query", "description": "REQUIRED. The ID to use for the job, which will become the final component of\n the job's resource name. This value should be 4-63 characters,\n and valid characters are /[a-z][0-9]-/.", "required": true, "schema": { "type": "string", "examples": [ "verification-001" ], "title": "individual_entity_verification_job_id", "maxLength": 63, "minLength": 4, "description": "REQUIRED. The ID to use for the job, which will become the final component of\n the job's resource name. This value should be 4-63 characters,\n and valid characters are /[a-z][0-9]-/." } } ], "requestBody": { "description": "Required. The individual entity verification job to create.", "content": { "application/json": { "schema": { "title": "individual_entity_verification_job", "description": "Required. The individual entity verification job to create.", "$ref": "#/components/schemas/bndry.api.risk.entities.v1alpha.IndividualEntityVerificationJob" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/bndry.api.risk.entities.v1alpha.IndividualEntityVerificationJob" } } } } } } }, "/v1alpha/individualEntityVerificationJobs/{individualEntityVerificationJob}": { "get": { "tags": [ "Individual Entity Verification" ], "summary": "Retrieve an individual entity verification job", "description": "Retrieves details about a specific individual entity verification job.", "operationId": "IndividualEntityVerificationJobService_GetIndividualEntityVerificationJob", "parameters": [ { "name": "individualEntityVerificationJob", "in": "path", "description": "The individualEntityVerificationJob id.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/bndry.api.risk.entities.v1alpha.IndividualEntityVerificationJob" } } } } } } }, "/v1alpha/individualEntityVerificationJobs/{individualEntityVerificationJob}/operations/{operation}": { "get": { "tags": [ "Individual Entity Verification" ], "summary": "GetOperation", "description": "Gets the latest state of a long-running operation. Clients can use this\n method to poll the operation result at intervals as recommended by the API\n service.", "operationId": "IndividualEntityVerificationJobService_GetOperation", "parameters": [ { "name": "individualEntityVerificationJob", "in": "path", "description": "The individualEntityVerificationJob id.", "required": true, "schema": { "type": "string" } }, { "name": "operation", "in": "path", "description": "The operation id.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/google.longrunning.Operation" } } } } } } }, "/v1alpha/individualEntityVerificationJobs/{individualEntityVerificationJob}:run": { "post": { "tags": [ "Individual Entity Verification" ], "summary": "Run an individual entity verification job", "description": "Runs an individual entity verification job.", "operationId": "IndividualEntityVerificationJobService_RunIndividualEntityVerificationJob", "parameters": [ { "name": "individualEntityVerificationJob", "in": "path", "description": "The individualEntityVerificationJob id.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "entityResourceName": { "type": "string", "examples": [ "entities/john-smith-001" ], "title": "entity_resource_name", "description": "Required. The resource name of the entity to verify.\n Format: entities/{entity}\ncorrect_entity_format // entity must follow format 'entities/*'\n" }, "redirectUri": { "type": "string", "examples": [ "https://app.example.com/verification/complete" ], "title": "redirect_uri", "format": "uri", "description": "Required. The final redirect URI where the user should be sent after verification is complete." } }, "title": "RunIndividualEntityVerificationJobRequest", "required": [ "entityResourceName", "redirectUri" ], "additionalProperties": false, "description": "Request message for [RunIndividualEntityVerificationJob][bndry.api.risk.entities.v1alpha.IndividualEntityVerificationJobService.RunIndividualEntityVerificationJob]." } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/google.longrunning.Operation" } } } } } } }, "/v1alpha/pepSanctionBusinessEntityJobs": { "get": { "tags": [ "PepSanctionBusinessEntityJobService" ], "summary": "List PEP and sanctions screening jobs for business entities", "description": "Lists PEP and sanctions screening jobs for a specific entity.", "operationId": "PepSanctionBusinessEntityJobService_ListPepSanctionBusinessEntityJobs", "parameters": [ { "name": "pageSize", "in": "query", "description": "Optional. The maximum number of jobs to return. The service may return fewer than\n this value.\n If unspecified, at most 10 jobs will be returned.\n The maximum value is 100; values above 100 will be coerced to 100.", "required": false, "schema": { "type": "integer", "examples": [ 25 ], "title": "page_size", "format": "int32", "description": "(OPTIONAL) Optional. The maximum number of jobs to return. The service may return fewer than\n this value.\n If unspecified, at most 10 jobs will be returned.\n The maximum value is 100; values above 100 will be coerced to 100." } }, { "name": "pageToken", "in": "query", "description": "Optional. A page token, received from a previous `ListPepSanctionBusinessEntityJobs` call.\n Provide this to retrieve the subsequent page.\n When paginating, all other parameters provided to `ListPepSanctionBusinessEntityJobs` must\n match the call that provided the page token.", "required": false, "schema": { "type": "string", "examples": [ "ChAIAhABGAEiAggC" ], "title": "page_token", "description": "(OPTIONAL) Optional. A page token, received from a previous `ListPepSanctionBusinessEntityJobs` call.\n Provide this to retrieve the subsequent page.\n When paginating, all other parameters provided to `ListPepSanctionBusinessEntityJobs` must\n match the call that provided the page token." } }, { "name": "skip", "in": "query", "description": "Optional. The number of jobs to skip before starting to collect the result set.", "required": false, "schema": { "type": "integer", "examples": [ 0 ], "title": "skip", "minimum": 0, "format": "int32", "description": "(OPTIONAL) Optional. The number of jobs to skip before starting to collect the result set." } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/bndry.api.risk.entities.v1alpha.ListPepSanctionBusinessEntityJobsResponse" } } } } } }, "post": { "tags": [ "PepSanctionBusinessEntityJobService" ], "summary": "Create a PEP and sanctions screening job for business entities", "description": "Creates a new PEP and sanctions screening job.", "operationId": "PepSanctionBusinessEntityJobService_CreatePepSanctionBusinessEntityJob", "parameters": [ { "name": "pepSanctionBusinessEntityJobId", "in": "query", "description": "REQUIRED. The ID to use for the job, which will become the final component of\n the job's resource name. This value should be 4-63 characters,\n and valid characters are /[a-z][0-9]-/.", "required": true, "schema": { "type": "string", "examples": [ "pep-sanction-screen-001" ], "title": "pep_sanction_business_entity_job_id", "maxLength": 63, "minLength": 4, "description": "REQUIRED. The ID to use for the job, which will become the final component of\n the job's resource name. This value should be 4-63 characters,\n and valid characters are /[a-z][0-9]-/." } } ], "requestBody": { "description": "Required. The PEP and sanctions screening job to create.", "content": { "application/json": { "schema": { "title": "pep_sanction_business_entity_job", "description": "Required. The PEP and sanctions screening job to create.", "$ref": "#/components/schemas/bndry.api.risk.entities.v1alpha.PepSanctionBusinessEntityJob" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/bndry.api.risk.entities.v1alpha.PepSanctionBusinessEntityJob" } } } } } } }, "/v1alpha/pepSanctionBusinessEntityJobs/{pepSanctionBusinessEntityJob}": { "get": { "tags": [ "PepSanctionBusinessEntityJobService" ], "summary": "Retrieve a PEP and sanctions screening job for a business entity", "description": "Retrieves details about a specific PEP and sanctions screening job.", "operationId": "PepSanctionBusinessEntityJobService_GetPepSanctionBusinessEntityJob", "parameters": [ { "name": "pepSanctionBusinessEntityJob", "in": "path", "description": "The pepSanctionBusinessEntityJob id.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/bndry.api.risk.entities.v1alpha.PepSanctionBusinessEntityJob" } } } } } } }, "/v1alpha/pepSanctionBusinessEntityJobs/{pepSanctionBusinessEntityJob}/operations/{operation}": { "get": { "tags": [ "PepSanctionBusinessEntityJobService" ], "summary": "GetOperation", "description": "Gets the latest state of a long-running operation. Clients can use this\n method to poll the operation result at intervals as recommended by the API\n service.", "operationId": "PepSanctionBusinessEntityJobService_GetOperation", "parameters": [ { "name": "pepSanctionBusinessEntityJob", "in": "path", "description": "The pepSanctionBusinessEntityJob id.", "required": true, "schema": { "type": "string" } }, { "name": "operation", "in": "path", "description": "The operation id.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/google.longrunning.Operation" } } } } } } }, "/v1alpha/pepSanctionBusinessEntityJobs/{pepSanctionBusinessEntityJob}:run": { "post": { "tags": [ "PepSanctionBusinessEntityJobService" ], "summary": "Run a PEP and sanctions screening job for a business entity", "description": "Runs a PEP and sanctions screening job.", "operationId": "PepSanctionBusinessEntityJobService_RunPepSanctionBusinessEntityJob", "parameters": [ { "name": "pepSanctionBusinessEntityJob", "in": "path", "description": "The pepSanctionBusinessEntityJob id.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "entity": { "type": "string", "examples": [ "entities/acme-corp-001" ], "title": "entity", "description": "Required. The resource name of the entity to screen.\n Format: entities/{entity}" } }, "title": "RunPepSanctionBusinessEntityJobRequest", "required": [ "entity" ], "additionalProperties": false, "description": "Request message for [RunPepSanctionBusinessEntityJob][bndry.api.risk.entities.v1alpha.PepSanctionBusinessEntityJobService.RunPepSanctionBusinessEntityJob]." } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/google.longrunning.Operation" } } } } } } } }, "components": { "schemas": { "bndry.api.datacollection.files.v1alpha.File": { "type": "object", "properties": { "name": { "type": "string", "title": "name", "description": "(IDENTIFIER) The resource name of the file.\n Format: files/{file}" }, "displayName": { "type": "string", "examples": [ "John Doe - Driver's License" ], "title": "display_name", "maxLength": 200, "minLength": 1, "description": "Optional. A mutable, user-settable field for providing a human-readable\n name for the file, to be used in user interfaces. Must be <= 200\n characters." }, "content": { "type": "string", "title": "content", "maxLength": 10485760, "minLength": 1, "format": "byte", "description": "The content of the file. Maximum file size is 10Mib." }, "createTime": { "title": "create_time", "description": "Output only. The timestamp when the file was created.", "readOnly": true, "$ref": "#/components/schemas/google.protobuf.Timestamp" }, "updateTime": { "title": "update_time", "description": "Output only. The timestamp when the file was most recently updated.", "readOnly": true, "$ref": "#/components/schemas/google.protobuf.Timestamp" } }, "title": "File", "required": [ "displayName", "content" ], "additionalProperties": false }, "bndry.api.datacollection.forms.v1alpha.CreateFormFileRequest": { "type": "object", "properties": { "parent": { "type": "string", "examples": [ "forms/form-001" ], "title": "parent", "description": "Required. The form under which to create the file.\n Format: forms/{form}\ncorrect_name_format // form must start with 'forms/'\n" }, "file": { "title": "file", "description": "Required. The file to create.", "$ref": "#/components/schemas/bndry.api.datacollection.files.v1alpha.File" } }, "title": "CreateFormFileRequest", "required": [ "parent", "file" ], "additionalProperties": false }, "bndry.api.datacollection.forms.v1alpha.CreateFormRequest": { "type": "object", "properties": { "form": { "title": "form", "$ref": "#/components/schemas/bndry.api.datacollection.forms.v1alpha.Form" }, "formId": { "type": "string", "examples": [ "compliance-form-202412-001" ], "title": "form_id", "description": "(OPTIONAL) " } }, "title": "CreateFormRequest", "required": [ "form" ], "additionalProperties": false, "description": "Request message for [bndry.api.forms.v1alpha.FormService.CreateForm]." }, "bndry.api.datacollection.forms.v1alpha.Form": { "type": "object", "properties": { "name": { "type": "string", "title": "name", "description": "(IDENTIFIER) The resource name of the form.\n Format: forms/{form}\n Format: workspaces/{workspace}/forms/{form}" }, "formDefinition": { "type": "string", "examples": [ "formDefinitions/kyc-beneficial-ownership" ], "title": "form_definition", "description": "(IMMUTABLE) Immutable. The resource name of the form definition used to create this form.\n Format: formDefinitions/{form_definition}" }, "formkitSchema": { "title": "formkit_schema", "description": "Output only. The schema of the form, derived from the form definition.", "readOnly": true, "$ref": "#/components/schemas/bndry.api.datacollection.forms.v1alpha.FormKitSchema" }, "response": { "title": "response", "description": "Required. The responses to the form questions, stored as a JSON object.", "$ref": "#/components/schemas/google.protobuf.Struct" }, "createTime": { "title": "create_time", "description": "Output only. The timestamp when the form was created.", "readOnly": true, "$ref": "#/components/schemas/google.protobuf.Timestamp" }, "updateTime": { "title": "update_time", "description": "Output only. The timestamp when the form was most recently updated.", "readOnly": true, "$ref": "#/components/schemas/google.protobuf.Timestamp" }, "etag": { "type": "string", "title": "etag", "description": "(OPTIONAL) Optional. The etag of the resource. Used for optimistic concurrency control\n as per AIP-154." }, "displayName": { "type": "string", "examples": [ "KYC Identity Verification - Jane Smith" ], "title": "display_name", "maxLength": 63, "description": "(OPTIONAL) Optional. A mutable, user-settable field for providing a human-readable\n name for the form, to be used in user interfaces. Must be <= 63\n characters." }, "workspaces": { "type": "array", "items": { "type": "string", "examples": [ "workspaces/due-diligence-ws-123" ], "description": "(OPTIONAL) " }, "title": "workspaces", "description": "(OPTIONAL) " }, "automations": { "type": "array", "items": { "type": "string", "examples": [ "automations/kyc-risk-assessment-auto-456" ], "description": "(OPTIONAL) " }, "title": "automations", "description": "(OPTIONAL) " }, "state": { "title": "state", "description": "Output only. The current state of the form.\n State can be changed using custom methods like `CloseForm` or `SubmitForm`.", "readOnly": true, "$ref": "#/components/schemas/bndry.api.datacollection.forms.v1alpha.Form.State" } }, "title": "Form", "required": [ "response" ], "additionalProperties": false, "description": "Represents a form instance, including its responses." }, "bndry.api.datacollection.forms.v1alpha.Form.State": { "type": "string", "title": "State", "enum": [ "STATE_UNSPECIFIED", "OPEN", "EXPIRED", "SUBMITTED" ], "description": "The state of the form" }, "bndry.api.datacollection.forms.v1alpha.FormKitSchema": { "type": "object", "properties": { "nodes": { "title": "nodes", "$ref": "#/components/schemas/google.protobuf.ListValue" } }, "title": "FormKitSchema", "required": [ "nodes" ], "additionalProperties": false }, "bndry.api.datacollection.forms.v1alpha.GetFormRequest": { "type": "object", "properties": { "name": { "type": "string", "examples": [ "workspaces/kyc-review-ws-789/forms/identity-verification-form" ], "title": "name", "description": "Required. The resource name of the workspace form to retrieve.\n Format: forms/{form}\n Format: workspaces/{workspace}/forms/{form}" } }, "title": "GetFormRequest", "required": [ "name" ], "additionalProperties": false, "description": "Request message for [FormService.GetForm][bndry.api.forms.v1alpha.FormService.GetForm]." }, "bndry.api.datacollection.forms.v1alpha.ListFormFilesRequest": { "type": "object", "properties": { "parent": { "type": "string", "examples": [ "forms/form-001" ], "title": "parent", "description": "Required. The parent form for which to list files.\n Format: forms/{form}" }, "pageSize": { "type": "integer", "examples": [ 25 ], "title": "page_size", "format": "int32", "description": "(OPTIONAL) Optional. The maximum number of forms to return. The service may return fewer than\n this value.\n If unspecified, at most 50 entities will be returned.\n The maximum value is 1000; values above 1000 will be coerced to 1000." }, "pageToken": { "type": "string", "examples": [ "ChAIAhABGAE" ], "title": "page_token", "description": "(OPTIONAL) Optional. A page token, received from a previous `ListForms` call.\n Provide this to retrieve the subsequent page.\n When paginating, all other parameters provided to `ListForms` must\n match the call that provided the page token." }, "showDeleted": { "type": "boolean", "title": "show_deleted", "description": "(OPTIONAL) Optional. If true, soft-deleted forms will be included in the response.\n See AIP-164." }, "skip": { "type": "integer", "examples": [ 50 ], "title": "skip", "format": "int32", "description": "(OPTIONAL) Optional. The number of forms to skip before starting to collect the result set." }, "orderBy": { "type": "string", "examples": [ "name desc" ], "title": "order_by", "description": "(OPTIONAL) " } }, "title": "ListFormFilesRequest", "required": [ "parent" ], "additionalProperties": false }, "bndry.api.datacollection.forms.v1alpha.ListFormFilesResponse": { "type": "object", "properties": { "files": { "type": "array", "items": { "$ref": "#/components/schemas/bndry.api.datacollection.files.v1alpha.File" }, "title": "files", "description": "The list of files." }, "nextPageToken": { "type": "string", "title": "next_page_token", "description": "A token to retrieve the next page of results." }, "totalSize": { "type": "integer", "title": "total_size", "format": "int32", "description": "The total number of files." } }, "title": "ListFormFilesResponse", "additionalProperties": false }, "bndry.api.datacollection.forms.v1alpha.ListFormsRequest": { "type": "object", "properties": { "parent": { "type": "string", "examples": [ "workspaces/aml-monitoring-ws-456" ], "title": "parent", "description": "Required. The parent workspace for which to list forms.\n Format: forms/\n Format: workspaces/{workspace}" }, "pageSize": { "type": "integer", "title": "page_size", "format": "int32", "description": "(OPTIONAL) Optional. The maximum number of forms to return. The service may return fewer than\n this value.\n If unspecified, at most 50 forms will be returned.\n The maximum value is 1000; values above 1000 will be coerced to 1000." }, "pageToken": { "type": "string", "title": "page_token", "description": "(OPTIONAL) Optional. A page token, received from a previous `ListWorkspaceForms` call.\n Provide this to retrieve the subsequent page.\n When paginating, all other parameters provided to `ListWorkspaceForms` must\n match the call that provided the page token." }, "skip": { "type": "integer", "title": "skip", "format": "int32", "description": "(OPTIONAL) Optional. The number of forms to skip before starting to collect the result set." } }, "title": "ListFormsRequest", "required": [ "parent" ], "additionalProperties": false, "description": "Request message for [WorkspaceService.ListForms][bndry.api.forms.v1alpha.WorkspaceService.ListForms].\n Request message for [FomrService.ListForms][bndry.api.forms.v1alpha.FormService.ListForms]." }, "bndry.api.datacollection.forms.v1alpha.ListFormsResponse": { "type": "object", "properties": { "forms": { "type": "array", "items": { "$ref": "#/components/schemas/bndry.api.datacollection.forms.v1alpha.Form" }, "title": "forms", "description": "The list of workspace forms." }, "nextPageToken": { "type": "string", "title": "next_page_token", "description": "A token to retrieve the next page of results, or empty if there are no\n more results in the list." }, "totalSize": { "type": "integer", "title": "total_size", "format": "int32", "description": "The total number of forms matching the request." } }, "title": "ListFormsResponse", "additionalProperties": false, "description": "Response message for [WorkspaceService.ListForms][bndry.api.forms.v1alpha.WorkspaceService.ListForms].\n Response message for [FomrService.ListForms][bndry.api.forms.v1alpha.FormService.ListForms]." }, "bndry.api.datacollection.forms.v1alpha.SubmitFormRequest": { "type": "object", "properties": { "name": { "type": "string", "examples": [ "forms/customer-due-diligence-form-789" ], "title": "name", "description": "Required. The resource name of the form to submit.\n Format: forms/{form}" } }, "title": "SubmitFormRequest", "required": [ "name" ], "additionalProperties": false, "description": "Request message for [bndry.api.forms.v1alpha.FormService.SubmitForm]." }, "bndry.api.datacollection.forms.v1alpha.SubmitFormResponse": { "type": "object", "properties": { "submitTime": { "title": "submit_time", "description": "The timestamp when the form was submitted.", "$ref": "#/components/schemas/google.protobuf.Timestamp" } }, "title": "SubmitFormResponse", "additionalProperties": false, "description": "Response message for [bndry.api.forms.v1alpha.FormService.SubmitForm]." }, "bndry.api.datacollection.forms.v1alpha.UpdateFormRequest": { "type": "object", "properties": { "form": { "title": "form", "description": "Required. The form to update.\n\n The form's `name` field is used to identify the form to update.\n Format: forms/{form}\n Format: workspaces/{workspace}/forms/{form}", "$ref": "#/components/schemas/bndry.api.datacollection.forms.v1alpha.Form" }, "updateMask": { "title": "update_mask", "description": "(OPTIONAL) Optional. The list of fields to be updated.\n\n If not provided (i.e., the mask is omitted), the server will update all\n fields that are populated in the `workspace_form` message in this request\n (i.e., fields that have a non-empty value).\n\n The special value `*` can be used for a full replacement of the resource,\n equivalent to a PUT operation. When using `*`, be cautious as new fields\n added to the resource in the future will also be updated.\n\n For robust updates, explicitly specifying the fields is recommended.\n\n See AIP-134 (Standard Update) and AIP-161 (Field Masks) for more details.", "$ref": "#/components/schemas/google.protobuf.FieldMask" } }, "title": "UpdateFormRequest", "required": [ "form" ], "additionalProperties": false, "description": "Request message for [FormService.UpdateForm][bndry.api.forms.v1alpha.FormService.UpdateForm]." }, "bndry.api.reference.geography.v1alpha.Country": { "type": "object", "properties": { "label": { "type": "string", "examples": [ "United States" ], "title": "label", "minLength": 1 }, "alphaCode2": { "type": "string", "examples": [ "US" ], "title": "alpha_code2", "maxLength": 2, "minLength": 2, "pattern": "^[A-Z]{2}$" } }, "title": "Country", "additionalProperties": false }, "bndry.api.risk.entities.v1alpha.ActivityLog": { "type": "object", "properties": { "name": { "type": "string", "examples": [ "activityLogs/01234567-89ab-cdef-0123-456789abcdef" ], "title": "name", "description": "(IDENTIFIER) The resource name of the activity.\n Format: activityLog/{activity_log}" }, "type": { "title": "type", "description": "Required. The type of the activity.", "$ref": "#/components/schemas/bndry.api.risk.entities.v1alpha.ActivityType" }, "source": { "title": "source", "description": "Required. The source that performed the activity.", "$ref": "#/components/schemas/bndry.api.risk.entities.v1alpha.ActivitySource" }, "payload": { "title": "payload", "description": "Required. The payload containing activity-specific data.", "$ref": "#/components/schemas/bndry.api.risk.entities.v1alpha.ActivityLogPayload" }, "createTime": { "title": "create_time", "description": "Output only. The timestamp when the activity was created.", "readOnly": true, "$ref": "#/components/schemas/google.protobuf.Timestamp" }, "updateTime": { "title": "update_time", "description": "Output only. The timestamp when the activity was last updated.", "readOnly": true, "$ref": "#/components/schemas/google.protobuf.Timestamp" }, "occurredTime": { "title": "occurred_time", "description": "Output only. The timestamp when the activity occurred.\n\n For special activity types, this field uses specific dates from the payload:\n - UNUSUAL_ACTIVITY_REPORT: Uses the incident_date from report_details\n - SUSPICIOUS_MATTER_REPORT: Uses the incident_date from report_details\n - CUSTOM: Uses the activity_time from the custom activity payload\n\n For all other activity types, or when the above dates are not provided,\n this defaults to the activity creation time.", "readOnly": true, "$ref": "#/components/schemas/google.protobuf.Timestamp" }, "deleteTime": { "title": "delete_time", "description": "Output only. The timestamp when the activity log was deleted.\n See AIP-164.", "readOnly": true, "$ref": "#/components/schemas/google.protobuf.Timestamp" }, "purgeTime": { "title": "purge_time", "description": "Output only. The timestamp when the activity log will be purged if soft-deleted.\n See AIP-164.", "readOnly": true, "$ref": "#/components/schemas/google.protobuf.Timestamp" }, "entityNames": { "type": "array", "items": { "type": "string", "examples": [ "entities/john-smith-001" ] }, "title": "entity_names", "minItems": 1, "description": "The entities involved in this activity." }, "entityDisplayNames": { "type": "array", "items": { "type": "string", "examples": [ "John Smith" ], "readOnly": true }, "title": "entity_display_names", "minItems": 1, "description": "The display names of the entities involved in this activity.", "readOnly": true }, "workspace": { "type": "string", "examples": [ "workspaces/01234567-89ab-cdef-0123-456789abcdef" ], "title": "workspace", "maxLength": 63, "description": "(OPTIONAL) The workspace involved in this activity." } }, "title": "ActivityLog", "required": [ "type", "source", "payload", "entityNames" ], "additionalProperties": false, "description": "Represents an activity performed against one or more entities." }, "bndry.api.risk.entities.v1alpha.ActivityLogPayload": { "type": "object", "oneOf": [ { "type": "object", "properties": { "bndryRiskRatingResult": { "title": "bndry_risk_rating_result", "$ref": "#/components/schemas/bndry.api.risk.rating.v1alpha.ActivityLog" } }, "title": "bndry_risk_rating_result", "required": [ "bndryRiskRatingResult" ] }, { "type": "object", "properties": { "custom": { "title": "custom", "$ref": "#/components/schemas/bndry.api.risk.entities.v1alpha.CustomActivityLog" } }, "title": "custom", "required": [ "custom" ] }, { "type": "object", "properties": { "formCreated": { "title": "form_created", "$ref": "#/components/schemas/bndry.api.risk.entities.v1alpha.FormCreatedActivityLog" } }, "title": "form_created", "required": [ "formCreated" ] }, { "type": "object", "properties": { "hawkRiskRatingResult": { "title": "hawk_risk_rating_result", "readOnly": true, "$ref": "#/components/schemas/hawk.v1alpha.CheckCustomerResponse" } }, "title": "hawk_risk_rating_result", "required": [ "hawkRiskRatingResult" ] }, { "type": "object", "properties": { "identityResearchResult": { "title": "identity_research_result", "$ref": "#/components/schemas/bndry.api.risk.entities.v1alpha.IdentityResearchActivityLog" } }, "title": "identity_research_result", "required": [ "identityResearchResult" ] }, { "type": "object", "properties": { "kyc6BusinessPepSanctionsResult": { "title": "kyc6_business_pep_sanctions_result", "readOnly": true, "$ref": "#/components/schemas/kyc6.business.v1alpha.ActivityLog" } }, "title": "kyc6_business_pep_sanctions_result", "required": [ "kyc6BusinessPepSanctionsResult" ] }, { "type": "object", "properties": { "kyc6PepSanctionsResult": { "title": "kyc6_pep_sanctions_result", "readOnly": true, "$ref": "#/components/schemas/kyc6.individual.v1alpha.ActivityLog" } }, "title": "kyc6_pep_sanctions_result", "required": [ "kyc6PepSanctionsResult" ] }, { "type": "object", "properties": { "rapidIdPepSanctionsResult": { "title": "rapid_id_pep_sanctions_result", "readOnly": true, "$ref": "#/components/schemas/rapidid.api.aml.v1alpha.ActivityLog" } }, "title": "rapid_id_pep_sanctions_result", "required": [ "rapidIdPepSanctionsResult" ] }, { "type": "object", "properties": { "rapididDvsResult": { "title": "rapidid_dvs_result", "$ref": "#/components/schemas/rapidid.api.dvs.v1alpha.ValidationResponse" } }, "title": "rapidid_dvs_result", "required": [ "rapididDvsResult" ] }, { "type": "object", "properties": { "simplekycKybProfile": { "title": "simplekyc_kyb_profile", "$ref": "#/components/schemas/simplekyc.kyb.v1alpha.ActivityLog" } }, "title": "simplekyc_kyb_profile", "required": [ "simplekycKybProfile" ] }, { "type": "object", "properties": { "suspiciousMatterReport": { "title": "suspicious_matter_report", "$ref": "#/components/schemas/bndry.api.risk.reporting.v1alpha.SMRActivityLog" } }, "title": "suspicious_matter_report", "required": [ "suspiciousMatterReport" ] }, { "type": "object", "properties": { "truuthIdentityVerificationResult": { "title": "truuth_identity_verification_result", "readOnly": true, "$ref": "#/components/schemas/bndry.api.risk.truuth.v1alpha.CallbackRequest" } }, "title": "truuth_identity_verification_result", "required": [ "truuthIdentityVerificationResult" ] }, { "type": "object", "properties": { "unusualActivityReport": { "title": "unusual_activity_report", "$ref": "#/components/schemas/bndry.api.risk.reporting.v1alpha.UARActivityLog" } }, "title": "unusual_activity_report", "required": [ "unusualActivityReport" ] } ], "title": "ActivityLogPayload", "additionalProperties": false }, "bndry.api.risk.entities.v1alpha.ActivityLogType": { "type": "object", "properties": { "name": { "type": "string", "examples": [ "activityLogTypes/customer-sign-in" ], "title": "name", "maxLength": 63, "description": "(IDENTIFIER) " }, "label": { "type": "string", "title": "label", "maxLength": 100, "minLength": 1 } }, "title": "ActivityLogType", "required": [ "label" ], "additionalProperties": false }, "bndry.api.risk.entities.v1alpha.ActivitySource": { "type": "string", "title": "ActivitySource", "enum": [ "ACTIVITY_SOURCE_UNSPECIFIED", "BNDRY", "RAPID_ID", "TRUUTH", "CONNECT_ID", "HAWK_AI", "KYC6", "CUSTOMER", "SIMPLE_KYC" ], "description": "Sources that can perform activities." }, "bndry.api.risk.entities.v1alpha.ActivityType": { "type": "string", "title": "ActivityType", "enum": [ "ACTIVITY_TYPE_UNSPECIFIED", "PEP_AND_SANCTIONS", "DOCUMENT_VERIFICATION", "IDENTITY_CHECK", "RISK_RATING", "UNUSUAL_ACTIVITY_REPORT", "SUSPICIOUS_MATTER_REPORT", "CUSTOM", "KYB_PROFILE", "FORM_CREATED", "IDENTITY_RESEARCH" ], "description": "Types of activities." }, "bndry.api.risk.entities.v1alpha.AddEntityRelationshipRequest": { "type": "object", "properties": { "name": { "type": "string", "examples": [ "entities/john-smith-001" ], "title": "name", "description": "correct_name_format // name must start with 'entities/'\n" }, "targetEntity": { "type": "string", "examples": [ "entities/example-financial-services" ], "title": "target_entity", "description": "correct_name_format // name must start with 'entities/'\n" }, "relationshipType": { "title": "relationship_type", "$ref": "#/components/schemas/bndry.api.risk.entities.v1alpha.RelationshipType" } }, "title": "AddEntityRelationshipRequest", "required": [ "name", "targetEntity", "relationshipType" ], "additionalProperties": false }, "bndry.api.risk.entities.v1alpha.AddTagRequest": { "type": "object", "properties": { "name": { "type": "string", "examples": [ "entities/john-smith-001" ], "title": "name", "description": "Required. The resource name of the entity.\n Format: entities/{entity}" }, "tag": { "title": "tag", "description": "Required. The tag to add to the entity.", "$ref": "#/components/schemas/bndry.api.risk.entities.v1alpha.Tag" } }, "title": "AddTagRequest", "required": [ "name", "tag" ], "additionalProperties": false, "description": "Request message for [bndry.api.risk.v1alpha.EntityService.AddTag]." }, "bndry.api.risk.entities.v1alpha.Address": { "type": "object", "properties": { "type": { "oneOf": [ { "$ref": "#/components/schemas/bndry.api.risk.entities.v1alpha.AddressType" }, { "type": "null" } ], "title": "type", "description": "The classification of this address, indicating whether it is a current or previous residential\n or business address, or a place of birth.", "readOnly": true }, "postalAddress": { "title": "postal_address", "description": "The postal address.", "readOnly": true, "$ref": "#/components/schemas/google.type.PostalAddress" } }, "title": "Address", "additionalProperties": false, "description": "A physical address associated with the individual, with a type indicating its purpose\n (e.g., residential, business, place of birth)." }, "bndry.api.risk.entities.v1alpha.AddressType": { "type": "string", "title": "AddressType", "enum": [ "ADDRESS_TYPE_UNSPECIFIED", "ADDRESS_TYPE_PLACE_OF_BIRTH", "ADDRESS_TYPE_RESIDENTIAL", "ADDRESS_TYPE_BUSINESS", "ADDRESS_TYPE_PREVIOUS_RESIDENTIAL", "ADDRESS_TYPE_PREVIOUS_BUSINESS" ], "description": "Type of physical address." }, "bndry.api.risk.entities.v1alpha.AdverseMediaEntry": { "type": "object", "properties": { "category": { "type": "string", "title": "category", "description": "The category of adverse media (e.g., \"Financial Crime\", \"Fraud\").", "readOnly": true }, "subcategory": { "type": [ "string", "null" ], "title": "subcategory", "description": "An optional subcategory providing more granular classification.", "readOnly": true }, "events": { "type": "array", "items": { "$ref": "#/components/schemas/bndry.api.risk.entities.v1alpha.AdverseMediaEvent" }, "title": "events", "description": "Timeline of events associated with this adverse media record.", "readOnly": true } }, "title": "AdverseMediaEntry", "additionalProperties": false, "description": "Represents a single adverse media (Reputational Risk Exposure) record.\n Mapped from the screening provider's RRE entry." }, "bndry.api.risk.entities.v1alpha.AdverseMediaEvent": { "type": "object", "properties": { "type": { "type": "string", "title": "type", "description": "The type of event (e.g., \"allegation\", \"conviction\", \"investigation\").", "readOnly": true }, "date": { "oneOf": [ { "$ref": "#/components/schemas/google.type.Date" }, { "type": "null" } ], "title": "date", "description": "The date of the event.", "readOnly": true }, "evidenceIds": { "type": "array", "items": { "type": "string", "readOnly": true }, "title": "evidence_ids", "description": "References to supporting evidence documents. Each ID corresponds to an evidence_id in the\n evidence list on the parent Match.", "readOnly": true } }, "title": "AdverseMediaEvent", "additionalProperties": false, "description": "A single event within an adverse media record." }, "bndry.api.risk.entities.v1alpha.AdverseMediaInfo": { "type": "object", "properties": { "entries": { "type": "array", "items": { "$ref": "#/components/schemas/bndry.api.risk.entities.v1alpha.AdverseMediaEntry" }, "title": "entries", "description": "Individual sanction listings. Each entry represents a listing by a specific sanctioning body.", "readOnly": true } }, "title": "AdverseMediaInfo", "additionalProperties": false, "description": "Contains Adverse Media information for the individual." }, "bndry.api.risk.entities.v1alpha.Alias": { "type": "object", "properties": { "name": { "title": "name", "description": "The alias as structured name components.", "readOnly": true, "$ref": "#/components/schemas/bndry.api.risk.entities.v1alpha.IndividualName" }, "type": { "oneOf": [ { "$ref": "#/components/schemas/bndry.api.risk.entities.v1alpha.AliasType" }, { "type": "null" } ], "title": "type", "description": "The type of alias, indicating the relationship to the primary name (e.g., original script name,\n spelling variation, maiden name).", "readOnly": true } }, "title": "Alias", "additionalProperties": false, "description": "An alternative name associated with an individual, such as a spelling variation, name in another\n script, maiden name, or nickname." }, "bndry.api.risk.entities.v1alpha.AliasType": { "type": "string", "title": "AliasType", "enum": [ "ALIAS_TYPE_UNSPECIFIED", "ALIAS_TYPE_ORIGINAL_SCRIPT_NAME", "ALIAS_TYPE_SPELLING_VARIATION", "ALIAS_TYPE_SHORTENED_NAME", "ALIAS_TYPE_MAIDEN_NAME", "ALIAS_TYPE_NICKNAME", "ALIAS_TYPE_PREVIOUS_NAME", "ALIAS_TYPE_FAKE_NAME" ], "description": "Classifies the relationship between an alias and the individual's primary name." }, "bndry.api.risk.entities.v1alpha.Associate": { "type": "object", "properties": { "name": { "title": "name", "description": "The structured name of the associated individual.", "readOnly": true, "$ref": "#/components/schemas/bndry.api.risk.entities.v1alpha.IndividualName" }, "relationship": { "type": "string", "title": "relationship", "description": "The nature of the relationship (e.g., \"spouse\", \"child\", \"business associate\").", "readOnly": true } }, "title": "Associate", "additionalProperties": false, "description": "Represents a known associate, family member, or linked individual related to the matched person." }, "bndry.api.risk.entities.v1alpha.BusinessAlias": { "type": "object", "properties": { "name": { "type": "string", "title": "name", "description": "The alias name.", "readOnly": true }, "type": { "oneOf": [ { "$ref": "#/components/schemas/bndry.api.risk.entities.v1alpha.BusinessAliasType" }, { "type": "null" } ], "title": "type", "description": "The type of alias, indicating the relationship to the primary name.", "readOnly": true } }, "title": "BusinessAlias", "additionalProperties": false, "description": "An alternative name associated with a business entity." }, "bndry.api.risk.entities.v1alpha.BusinessAliasType": { "type": "string", "title": "BusinessAliasType", "enum": [ "BUSINESS_ALIAS_TYPE_UNSPECIFIED", "BUSINESS_ALIAS_TYPE_ORIGINAL_SCRIPT_NAME", "BUSINESS_ALIAS_TYPE_SPELLING_VARIATION", "BUSINESS_ALIAS_TYPE_ABBREVIATION", "BUSINESS_ALIAS_TYPE_PREVIOUS_NAME", "BUSINESS_ALIAS_TYPE_BRAND_NAME", "BUSINESS_ALIAS_TYPE_FAKE_NAME" ], "description": "Classifies the relationship between an alias and the business's primary name." }, "bndry.api.risk.entities.v1alpha.BusinessAssociate": { "type": "object", "properties": { "name": { "type": "string", "title": "name", "description": "The name of the associated business entity.", "readOnly": true }, "relationship": { "type": "string", "title": "relationship", "description": "The nature of the relationship (e.g., \"parent company\", \"subsidiary\", \"joint venture\").", "readOnly": true }, "ownershipPercentage": { "type": [ "integer", "null" ], "title": "ownership_percentage", "format": "int32", "description": "Ownership percentage, if applicable.", "readOnly": true }, "datasets": { "type": "array", "items": { "$ref": "#/components/schemas/bndry.api.risk.entities.v1alpha.DatasetTag" }, "title": "datasets", "description": "Classification tags indicating which risk categories the linked business appears in.", "readOnly": true } }, "title": "BusinessAssociate", "additionalProperties": false, "description": "A linked business entity associated with the matched business." }, "bndry.api.risk.entities.v1alpha.BusinessEntityType": { "type": "string", "title": "BusinessEntityType", "enum": [ "BUSINESS_ENTITY_TYPE_UNSPECIFIED", "BUSINESS_ENTITY_TYPE_VESSEL", "BUSINESS_ENTITY_TYPE_AIRCRAFT", "BUSINESS_ENTITY_TYPE_TERRORIST_ORGANISATION", "BUSINESS_ENTITY_TYPE_ORGANISED_CRIME_GROUP", "BUSINESS_ENTITY_TYPE_MILITANT_GROUP", "BUSINESS_ENTITY_TYPE_SHELL_CORPORATION", "BUSINESS_ENTITY_TYPE_SOVEREIGN_WEALTH_FUND", "BUSINESS_ENTITY_TYPE_GOVERNMENT_BODY", "BUSINESS_ENTITY_TYPE_POLITICAL_PARTY", "BUSINESS_ENTITY_TYPE_CIVIC_MOVEMENT", "BUSINESS_ENTITY_TYPE_INTERNATIONAL_ORGANISATION", "BUSINESS_ENTITY_TYPE_NON_GOVERNMENT_ORGANISATION", "BUSINESS_ENTITY_TYPE_CHARITABLE_ORGANISATION", "BUSINESS_ENTITY_TYPE_PROFESSIONAL_ORGANISATION", "BUSINESS_ENTITY_TYPE_PRIVATELY_HELD_COMPANY", "BUSINESS_ENTITY_TYPE_PUBLICLY_TRADED_COMPANY", "BUSINESS_ENTITY_TYPE_TRUST_FUND", "BUSINESS_ENTITY_TYPE_BANK", "BUSINESS_ENTITY_TYPE_CRYPTOCURRENCY_BUSINESS", "BUSINESS_ENTITY_TYPE_GAMING_BUSINESS", "BUSINESS_ENTITY_TYPE_NON_BANK_FINANCIAL_INSTITUTION", "BUSINESS_ENTITY_TYPE_DESIGNATED_PROFESSIONAL_ORGANISATION", "BUSINESS_ENTITY_TYPE_WEBSITE", "BUSINESS_ENTITY_TYPE_FAKE_ENTITY", "BUSINESS_ENTITY_TYPE_APPLICATION" ], "description": "Classifies the type of business entity." }, "bndry.api.risk.entities.v1alpha.BusinessMatch": { "type": "object", "properties": { "providerReference": { "title": "provider_reference", "description": "Identifiers that can be used to look up the full record against the screening provider,\n or to correlate results across subsequent screenings.", "readOnly": true, "$ref": "#/components/schemas/bndry.api.risk.entities.v1alpha.ProviderReference" }, "primaryName": { "type": "string", "title": "primary_name", "description": "The business's primary or official name as recorded by the screening provider.", "readOnly": true }, "matchedName": { "type": [ "string", "null" ], "title": "matched_name", "description": "The specific name variant (e.g., alias or spelling variation) that triggered this match.", "readOnly": true }, "score": { "type": "number", "title": "score", "format": "float", "description": "Confidence score from 0.0 (no confidence) to 1.0 (exact match).", "readOnly": true }, "datasets": { "type": "array", "items": { "$ref": "#/components/schemas/bndry.api.risk.entities.v1alpha.DatasetTag" }, "title": "datasets", "description": "Classification tags indicating which risk categories this entity appears in\n (e.g., sanctioned, reputational risk, SOE). A single match may belong to multiple datasets.", "readOnly": true }, "name": { "type": [ "string", "null" ], "title": "name", "description": "The matched business entity's name from the provider's profile.", "readOnly": true }, "description": { "type": [ "string", "null" ], "title": "description", "description": "A description of the business entity.", "readOnly": true }, "aliases": { "type": "array", "items": { "$ref": "#/components/schemas/bndry.api.risk.entities.v1alpha.BusinessAlias" }, "title": "aliases", "description": "Alternative names associated with this business, including spelling variations, names in other\n scripts, previous names, brand names, and abbreviations.", "readOnly": true }, "addresses": { "type": "array", "items": { "$ref": "#/components/schemas/bndry.api.risk.entities.v1alpha.Address" }, "title": "addresses", "description": "Known addresses or locations associated with this business, including registered,\n operating, and previous addresses.", "readOnly": true }, "profileImages": { "type": "array", "items": { "type": "string", "readOnly": true }, "title": "profile_images", "description": "URIs to profile images of the business, when available from the provider.", "readOnly": true }, "identifiers": { "type": "array", "items": { "$ref": "#/components/schemas/bndry.api.risk.entities.v1alpha.Identifier" }, "title": "identifiers", "description": "Business identification documents and numbers, such as registration numbers,\n tax identifiers, or LEI codes.", "readOnly": true }, "contactEntries": { "type": "array", "items": { "$ref": "#/components/schemas/bndry.api.risk.entities.v1alpha.ContactEntry" }, "title": "contact_entries", "description": "Contact information for the business, such as telephone numbers, fax numbers,\n or website URLs.", "readOnly": true }, "notes": { "type": "array", "items": { "type": "string", "readOnly": true }, "title": "notes", "description": "Free-text notes or annotations associated with this entity's record.", "readOnly": true }, "businessTypes": { "type": "array", "items": { "$ref": "#/components/schemas/bndry.api.risk.entities.v1alpha.BusinessEntityType" }, "title": "business_types", "description": "Classifications of the business entity (e.g., vessel, shell corporation, government body).", "readOnly": true }, "activities": { "type": "array", "items": { "type": "string", "readOnly": true }, "title": "activities", "description": "Business sectors or areas of activity.", "readOnly": true }, "sanctions": { "title": "sanctions", "description": "Sanctions list details, including the sanctioning body, regime, measures imposed, and event\n timeline. Only present when the entity appears on one or more sanctions lists.", "readOnly": true, "$ref": "#/components/schemas/bndry.api.risk.entities.v1alpha.SanctionsInfo" }, "regulatoryEnforcementEntries": { "type": "array", "items": { "$ref": "#/components/schemas/bndry.api.risk.entities.v1alpha.RegulatoryEnforcementEntry" }, "title": "regulatory_enforcement_entries", "description": "Regulatory enforcement actions taken against this entity.", "readOnly": true }, "reputationalRiskEntries": { "type": "array", "items": { "$ref": "#/components/schemas/bndry.api.risk.entities.v1alpha.ReputationalRiskEntry" }, "title": "reputational_risk_entries", "description": "Reputational risk exposure entries (adverse media).", "readOnly": true }, "interestProfileEntries": { "type": "array", "items": { "$ref": "#/components/schemas/bndry.api.risk.entities.v1alpha.ProfileOfInterestEntry" }, "title": "interest_profile_entries", "description": "Interest profile entries, indicating positions or roles held by the entity.", "readOnly": true }, "insolvencyEntries": { "type": "array", "items": { "$ref": "#/components/schemas/bndry.api.risk.entities.v1alpha.InsolvencyEntry" }, "title": "insolvency_entries", "description": "Insolvency or bankruptcy records for this entity.", "readOnly": true }, "stateOwnedEnterprise": { "oneOf": [ { "$ref": "#/components/schemas/bndry.api.risk.entities.v1alpha.StateOwnedEnterpriseEntry" }, { "type": "null" } ], "title": "state_owned_enterprise", "description": "State-owned enterprise classification, if applicable.", "readOnly": true }, "gamblingRiskEntries": { "type": "array", "items": { "$ref": "#/components/schemas/bndry.api.risk.entities.v1alpha.GamblingRiskEntry" }, "title": "gambling_risk_entries", "description": "Gambling risk intelligence entries.", "readOnly": true }, "linkedIndividuals": { "type": "array", "items": { "$ref": "#/components/schemas/bndry.api.risk.entities.v1alpha.Associate" }, "title": "linked_individuals", "description": "Linked individuals associated with this business entity (e.g., directors, officers,\n beneficial owners).", "readOnly": true }, "linkedBusinesses": { "type": "array", "items": { "$ref": "#/components/schemas/bndry.api.risk.entities.v1alpha.BusinessAssociate" }, "title": "linked_businesses", "description": "Linked businesses associated with this entity (e.g., parent companies, subsidiaries).", "readOnly": true }, "evidence": { "type": "array", "items": { "$ref": "#/components/schemas/bndry.api.risk.entities.v1alpha.Evidence" }, "title": "evidence", "description": "Supporting evidence and source documentation that substantiates the risk information.\n Evidence items may be referenced by their evidence_id from sanction events, regulatory\n enforcement entries, and other records.", "readOnly": true }, "providerUpdateTime": { "oneOf": [ { "$ref": "#/components/schemas/google.protobuf.Timestamp" }, { "type": "null" } ], "title": "provider_update_time", "description": "When the screening provider last updated this record.", "readOnly": true }, "providerCreateTime": { "oneOf": [ { "$ref": "#/components/schemas/google.protobuf.Timestamp" }, { "type": "null" } ], "title": "provider_create_time", "description": "When this record was first created in the screening provider's system.", "readOnly": true } }, "title": "BusinessMatch", "additionalProperties": false, "description": "Represents a business entity record from a screening provider that potentially matches the query.\n Contains entity information, risk classification, and supporting evidence." }, "bndry.api.risk.entities.v1alpha.BusinessPepSanctionResult": { "type": "object", "properties": { "provider": { "title": "provider", "description": "Identifies which screening provider (e.g., KYC6) produced these results.", "readOnly": true, "$ref": "#/components/schemas/bndry.api.risk.entities.v1alpha.ScreeningProvider" }, "query": { "title": "query", "description": "Contains the search parameters that were submitted, useful for auditing what was screened.", "readOnly": true, "$ref": "#/components/schemas/bndry.api.risk.entities.v1alpha.BusinessQueryContext" }, "matches": { "type": "array", "items": { "$ref": "#/components/schemas/bndry.api.risk.entities.v1alpha.BusinessMatch" }, "title": "matches", "description": "Ordered by relevance score (highest first). May be empty if no matches were found.", "readOnly": true } }, "title": "BusinessPepSanctionResult", "additionalProperties": false, "description": "The output of a business entity PEP and sanctions screening check, containing the original\n query parameters and any matches found." }, "bndry.api.risk.entities.v1alpha.BusinessQueryContext": { "type": "object", "properties": { "name": { "type": [ "string", "null" ], "title": "name", "description": "(OPTIONAL) The business name that was searched." }, "countries": { "type": "array", "items": { "type": "string", "description": "(OPTIONAL) " }, "title": "countries", "description": "(OPTIONAL) Country codes used to filter results (ISO 3166-1 alpha-2)." }, "fuzziness": { "type": [ "number", "null" ], "title": "fuzziness", "format": "float", "description": "(OPTIONAL) Controls how loosely names are matched. A value of 0.0 requires an exact match; 1.0 allows\n maximum fuzziness." }, "exactMatch": { "type": [ "boolean", "null" ], "title": "exact_match", "description": "(OPTIONAL) When true, only exact name matches are returned. Overrides fuzziness." } }, "title": "BusinessQueryContext", "additionalProperties": false, "description": "The original query parameters submitted for business entity screening." }, "bndry.api.risk.entities.v1alpha.ContactCategory": { "type": "string", "title": "ContactCategory", "enum": [ "CONTACT_CATEGORY_UNSPECIFIED", "CONTACT_CATEGORY_TELEPHONE", "CONTACT_CATEGORY_FAX", "CONTACT_CATEGORY_MOBILE", "CONTACT_CATEGORY_EMAIL", "CONTACT_CATEGORY_WEBSITE" ], "description": "Category of contact information." }, "bndry.api.risk.entities.v1alpha.ContactEntry": { "type": "object", "properties": { "category": { "title": "category", "description": "Category of contact.", "readOnly": true, "$ref": "#/components/schemas/bndry.api.risk.entities.v1alpha.ContactCategory" }, "value": { "type": "string", "title": "value", "description": "The contact detail value (e.g., the phone number or email address).", "readOnly": true } }, "title": "ContactEntry", "additionalProperties": false, "description": "A contact method for the individual, such as a phone number, email address, or fax number." }, "bndry.api.risk.entities.v1alpha.CreateActivityLogRequest": { "type": "object", "properties": { "activityLog": { "title": "activity_log", "description": "Required. The entity to create.", "$ref": "#/components/schemas/bndry.api.risk.entities.v1alpha.ActivityLog" }, "activityLogId": { "type": "string", "examples": [ "activity-log-001" ], "title": "activity_log_id", "maxLength": 63, "minLength": 4, "description": "(OPTIONAL) Optional. The ID to use for the entity, which will become the final component of\n the entity's resource name. This value should be 4-63 characters,\n and valid characters are /[a-z][0-9]-/." } }, "title": "CreateActivityLogRequest", "required": [ "activityLog" ], "additionalProperties": false }, "bndry.api.risk.entities.v1alpha.CreateActivityLogTypeRequest": { "type": "object", "properties": { "activityLogType": { "title": "activity_log_type", "$ref": "#/components/schemas/bndry.api.risk.entities.v1alpha.ActivityLogType" }, "activityLogTypeId": { "type": "string", "examples": [ "customer-sign-in" ], "title": "activity_log_type_id", "maxLength": 63, "minLength": 4, "description": "(OPTIONAL) Optional. The ID to use for the activity log type, which will become the final component of\n the resource name. This value should be 4-63 characters,\n and valid characters are /[a-z][0-9]-/." } }, "title": "CreateActivityLogTypeRequest", "required": [ "activityLogType" ], "additionalProperties": false }, "bndry.api.risk.entities.v1alpha.CreateEntityFileRequest": { "type": "object", "properties": { "parent": { "type": "string", "examples": [ "entities/john-smith-001" ], "title": "parent", "description": "Required. The entity under which to create the file.\n Format: entities/{entity}\ncorrect_name_format // entity must start with 'entities/'\n" }, "file": { "title": "file", "description": "Required. The file to create.", "$ref": "#/components/schemas/bndry.api.datacollection.files.v1alpha.File" } }, "title": "CreateEntityFileRequest", "required": [ "parent", "file" ], "additionalProperties": false }, "bndry.api.risk.entities.v1alpha.CreateEntityRequest": { "type": "object", "properties": { "entity": { "title": "entity", "description": "Required. The entity to create.", "$ref": "#/components/schemas/bndry.api.risk.entities.v1alpha.Entity" }, "entityId": { "type": "string", "examples": [ "john-smith-001" ], "title": "entity_id", "maxLength": 63, "minLength": 4, "description": "(OPTIONAL) Optional. The ID to use for the entity, which will become the final component of\n the entity's resource name. This value should be 4-63 characters,\n and valid characters are /[a-z][0-9]-/." } }, "title": "CreateEntityRequest", "required": [ "entity" ], "additionalProperties": false, "description": "Request message for [bndry.api.risk.v1alpha.EntityService.CreateEntity]." }, "bndry.api.risk.entities.v1alpha.CreateIndividualEntityRiskRatingJobRequest": { "type": "object", "properties": { "parent": { "type": "string", "examples": [ "entities/-" ], "title": "parent", "description": "Required. The parent entity resource name.\n Format: entities/-", "const": "entities/-" }, "individualEntityRiskRatingJob": { "title": "individual_entity_risk_rating_job", "description": "Required. The risk rating job to create.", "$ref": "#/components/schemas/bndry.api.risk.entities.v1alpha.IndividualEntityRiskRatingJob" }, "individualEntityRiskRatingJobId": { "type": "string", "examples": [ "pep-sanction-screen-001" ], "title": "individual_entity_risk_rating_job_id", "maxLength": 63, "minLength": 4, "description": "REQUIRED. The ID to use for the job, which will become the final component of\n the job's resource name. This value should be 4-63 characters,\n and valid characters are /[a-z][0-9]-/." } }, "title": "CreateIndividualEntityRiskRatingJobRequest", "required": [ "parent", "individualEntityRiskRatingJob", "individualEntityRiskRatingJobId" ], "additionalProperties": false, "description": "Request message for [CreateIndividualEntityRiskRatingJob][hawk.v1alpha.IndividualEntityRiskRatingJobService.CreateIndividualEntityRiskRatingJob]." }, "bndry.api.risk.entities.v1alpha.CreateIndividualEntityVerificationJobRequest": { "type": "object", "properties": { "individualEntityVerificationJob": { "title": "individual_entity_verification_job", "description": "Required. The individual entity verification job to create.", "$ref": "#/components/schemas/bndry.api.risk.entities.v1alpha.IndividualEntityVerificationJob" }, "individualEntityVerificationJobId": { "type": "string", "examples": [ "verification-001" ], "title": "individual_entity_verification_job_id", "maxLength": 63, "minLength": 4, "description": "REQUIRED. The ID to use for the job, which will become the final component of\n the job's resource name. This value should be 4-63 characters,\n and valid characters are /[a-z][0-9]-/." } }, "title": "CreateIndividualEntityVerificationJobRequest", "required": [ "individualEntityVerificationJob", "individualEntityVerificationJobId" ], "additionalProperties": false, "description": "Request message for [CreateIndividualEntityVerificationJob][bndry.api.risk.entities.v1alpha.IndividualEntityVerificationJobService.CreateIndividualEntityVerificationJob]." }, "bndry.api.risk.entities.v1alpha.CreateOnboardIndividualEntityJobRequest": { "type": "object", "properties": { "parent": { "type": "string", "examples": [ "entities/-" ], "title": "parent", "description": "Required. The parent entity resource name.\n Format: entities/-", "const": "entities/-" }, "onboardIndividualEntityJob": { "title": "onboard_individual_entity_job", "description": "Required. The onboard individual entity job to create.", "$ref": "#/components/schemas/bndry.api.risk.entities.v1alpha.OnboardIndividualEntityJob" }, "onboardIndividualEntityJobId": { "type": "string", "examples": [ "kyc-individual-mfs-001" ], "title": "onboard_individual_entity_job_id", "maxLength": 63, "minLength": 4, "description": "REQUIRED. The ID to use for the job, which will become the final component of\n the job's resource name. This value should be 4-63 characters,\n and valid characters are /[a-z][0-9]-/." } }, "title": "CreateOnboardIndividualEntityJobRequest", "required": [ "parent", "onboardIndividualEntityJob", "onboardIndividualEntityJobId" ], "additionalProperties": false, "description": "Request message for [CreateOnboardIndividualEntityJob][bndry.api.risk.entities.v1alpha.OnboardIndividualEntityJobService.CreateOnboardIndividualEntityJob]." }, "bndry.api.risk.entities.v1alpha.CreatePepSanctionBusinessEntityJobRequest": { "type": "object", "properties": { "pepSanctionBusinessEntityJob": { "title": "pep_sanction_business_entity_job", "description": "Required. The PEP and sanctions screening job to create.", "$ref": "#/components/schemas/bndry.api.risk.entities.v1alpha.PepSanctionBusinessEntityJob" }, "pepSanctionBusinessEntityJobId": { "type": "string", "examples": [ "pep-sanction-screen-001" ], "title": "pep_sanction_business_entity_job_id", "maxLength": 63, "minLength": 4, "description": "REQUIRED. The ID to use for the job, which will become the final component of\n the job's resource name. This value should be 4-63 characters,\n and valid characters are /[a-z][0-9]-/." } }, "title": "CreatePepSanctionBusinessEntityJobRequest", "required": [ "pepSanctionBusinessEntityJob", "pepSanctionBusinessEntityJobId" ], "additionalProperties": false, "description": "Request message for [CreatePepSanctionBusinessEntityJob][bndry.api.risk.entities.v1alpha.PepSanctionBusinessEntityJobService.CreatePepSanctionBusinessEntityJob]." }, "bndry.api.risk.entities.v1alpha.CreatePepSanctionIndividualEntityJobRequest": { "type": "object", "properties": { "parent": { "type": "string", "examples": [ "entities/-" ], "title": "parent", "description": "Required. The parent entity resource name.\n Format: entities/-", "const": "entities/-" }, "pepSanctionIndividualEntityJob": { "title": "pep_sanction_individual_entity_job", "description": "Required. The PEP and sanctions screening job to create.", "$ref": "#/components/schemas/bndry.api.risk.entities.v1alpha.PepSanctionIndividualEntityJob" }, "pepSanctionIndividualEntityJobId": { "type": "string", "examples": [ "pep-sanction-screen-001" ], "title": "pep_sanction_individual_entity_job_id", "maxLength": 63, "minLength": 4, "description": "REQUIRED. The ID to use for the job, which will become the final component of\n the job's resource name. This value should be 4-63 characters,\n and valid characters are /[a-z][0-9]-/." } }, "title": "CreatePepSanctionIndividualEntityJobRequest", "required": [ "parent", "pepSanctionIndividualEntityJob", "pepSanctionIndividualEntityJobId" ], "additionalProperties": false, "description": "Request message for [CreatePepSanctionIndividualEntityJob][bndry.api.risk.entities.v1alpha.PepSanctionIndividualEntityJobService.CreatePepSanctionIndividualEntityJob]." }, "bndry.api.risk.entities.v1alpha.CustomActivityLog": { "type": "object", "properties": { "fileIds": { "type": "array", "items": { "type": "string", "description": "(OPTIONAL) " }, "title": "file_ids", "description": "(OPTIONAL) file_ids of the uploaded report" }, "comments": { "type": "string", "title": "comments", "description": "(OPTIONAL) Additional comments to be included" }, "activityTime": { "title": "activity_time", "description": "datetime the incident occurred", "$ref": "#/components/schemas/google.protobuf.Timestamp" }, "activityLogType": { "type": "string", "examples": [ "activityLogTypes/customer-sign-in" ], "title": "activity_log_type", "minLength": 1 }, "documentIds": { "type": "array", "items": { "type": "string", "description": "(OPTIONAL) ", "deprecated": true }, "title": "document_ids", "description": "(OPTIONAL) Deprecated: use file_ids instead", "deprecated": true } }, "title": "CustomActivityLog", "required": [ "activityTime", "activityLogType" ], "additionalProperties": false }, "bndry.api.risk.entities.v1alpha.DatasetTag": { "type": "string", "title": "DatasetTag", "enum": [ "DATASET_TAG_UNSPECIFIED", "DATASET_TAG_PEP", "DATASET_TAG_PEP_CURRENT", "DATASET_TAG_PEP_FORMER", "DATASET_TAG_PEP_LINKED", "DATASET_TAG_SANCTIONS", "DATASET_TAG_SANCTIONS_CURRENT", "DATASET_TAG_SANCTIONS_FORMER", "DATASET_TAG_INSOLVENCY", "DATASET_TAG_REPUTATIONAL_RISK", "DATASET_TAG_DISQUALIFIED_DIRECTOR", "DATASET_TAG_PROFILE_OF_INTEREST", "DATASET_TAG_REGULATORY_ENFORCEMENT", "DATASET_TAG_STATE_OWNED_ENTERPRISE_CURRENT", "DATASET_TAG_STATE_OWNED_ENTERPRISE_FORMER", "DATASET_TAG_GAMBLING_RISK", "DATASET_TAG_IDENTITY", "DATASET_TAG_CORPORATE" ], "description": "Classification tags indicating which risk databases or categories a match or evidence item belongs to." }, "bndry.api.risk.entities.v1alpha.DeleteActivityLogRequest": { "type": "object", "properties": { "name": { "type": "string", "examples": [ "activityLogs/01234567-89ab-cdef-0123-456789abcdef" ], "title": "name", "description": "Required. The resource name of the activity log to delete.\n Format: activityLogs/{activity_log}\ncorrect_name_format // name must start with 'activityLogs/'\n" } }, "title": "DeleteActivityLogRequest", "required": [ "name" ], "additionalProperties": false, "description": "Request message for [EntityService.DeleteActivityLog]." }, "bndry.api.risk.entities.v1alpha.DeleteEntityRequest": { "type": "object", "properties": { "name": { "type": "string", "examples": [ "entities/example-financial-services" ], "title": "name", "description": "Required. The resource name of the entity to delete.\n Format: entities/{entity}\nno_wildcards // name must not contain wildcards\n" } }, "title": "DeleteEntityRequest", "required": [ "name" ], "additionalProperties": false, "description": "Request message for [bndry.api.risk.v1alpha.EntityService.DeleteEntity]." }, "bndry.api.risk.entities.v1alpha.Entity": { "type": "object", "allOf": [ { "properties": { "name": { "type": "string", "title": "name", "description": "(IDENTIFIER) The resource name of the entity.\n Format: entities/{entity}" }, "displayName": { "type": "string", "examples": [ "Example Financial Services Ltd" ], "title": "display_name", "maxLength": 63, "description": "(OPTIONAL) Optional. A mutable, user-settable field for providing a human-readable\n name for the entity, to be used in user interfaces. Must be <= 63\n characters." }, "contactInfo": { "title": "contact_info", "description": "(OPTIONAL) ", "$ref": "#/components/schemas/bndry.api.risk.entities.v1alpha.Entity.ContactInfo" }, "registration": { "type": "object", "title": "registration", "additionalProperties": { "title": "value", "$ref": "#/components/schemas/bndry.api.risk.entities.v1alpha.Entity.RegistrationDetails" }, "description": "(OPTIONAL) " }, "riskDetails": { "title": "risk_details", "description": "(OPTIONAL) ", "$ref": "#/components/schemas/bndry.api.risk.entities.v1alpha.Entity.RiskDetails" }, "entityRelationships": { "type": "array", "items": { "$ref": "#/components/schemas/bndry.api.risk.entities.v1alpha.Entity.EntityRelationship" }, "title": "entity_relationships", "description": "(OPTIONAL) " }, "externalIds": { "title": "external_ids", "description": "(OPTIONAL) ", "$ref": "#/components/schemas/bndry.api.risk.entities.v1alpha.Entity.ExternalIds" }, "tags": { "type": "array", "items": { "$ref": "#/components/schemas/bndry.api.risk.entities.v1alpha.Tag" }, "title": "tags", "description": "(OPTIONAL) Optional. Tags associated with the entity." }, "createTime": { "title": "create_time", "description": "Output only. The timestamp when the entity was created.", "readOnly": true, "$ref": "#/components/schemas/google.protobuf.Timestamp" }, "updateTime": { "title": "update_time", "description": "Output only. The timestamp when the entity was most recently updated.", "readOnly": true, "$ref": "#/components/schemas/google.protobuf.Timestamp" }, "purgeTime": { "title": "purge_time", "description": "Output only. The timestamp when the entity will be purged if soft-deleted.\n See AIP-164.", "readOnly": true, "$ref": "#/components/schemas/google.protobuf.Timestamp" }, "annotations": { "type": "object", "title": "annotations", "additionalProperties": { "type": "string", "title": "value" }, "description": "(OPTIONAL) Optional. Annotations for arbitrary metadata.\n See AIP-148." }, "etag": { "type": "string", "examples": [ "abc123" ], "title": "etag", "maxLength": 256, "description": "(OPTIONAL) Optional. The etag of the resource. Used for optimistic concurrency control\n as per AIP-154." } } }, { "oneOf": [ { "type": "object", "properties": { "company": { "title": "company", "$ref": "#/components/schemas/bndry.api.risk.entities.v1alpha.Entity.Company" } }, "title": "company", "required": [ "company" ] }, { "type": "object", "properties": { "individual": { "title": "individual", "$ref": "#/components/schemas/bndry.api.risk.entities.v1alpha.Entity.Individual" } }, "title": "individual", "required": [ "individual" ] }, { "type": "object", "properties": { "trust": { "title": "trust", "$ref": "#/components/schemas/bndry.api.risk.entities.v1alpha.Entity.Trust" } }, "title": "trust", "required": [ "trust" ] } ] } ], "title": "Entity", "additionalProperties": false }, "bndry.api.risk.entities.v1alpha.Entity.AnnotationsEntry": { "type": "object", "properties": { "key": { "type": "string", "title": "key" }, "value": { "type": "string", "title": "value" } }, "title": "AnnotationsEntry", "additionalProperties": false }, "bndry.api.risk.entities.v1alpha.Entity.Company": { "type": "object", "properties": { "type": { "title": "type", "$ref": "#/components/schemas/bndry.api.risk.entities.v1alpha.Entity.Company.CompanyType" }, "industry": { "type": "string", "examples": [ "Financial Services" ], "title": "industry", "maxLength": 256, "description": "(OPTIONAL) " } }, "title": "Company", "required": [ "type" ], "additionalProperties": false }, "bndry.api.risk.entities.v1alpha.Entity.Company.CompanyType": { "type": "string", "title": "CompanyType", "enum": [ "COMPANY_TYPE_UNSPECIFIED", "PUBLIC_COMPANY", "PRIVATE_COMPANY", "NON_PROFIT", "GOVERNMENTAL_ORG", "ASSOCIATION_INCORPORATION" ] }, "bndry.api.risk.entities.v1alpha.Entity.ContactInfo": { "type": "object", "properties": { "telephone": { "type": "array", "items": { "type": "string", "examples": [ "+61 2 9876 5432" ], "maxLength": 30, "description": "(OPTIONAL) " }, "title": "telephone", "description": "(OPTIONAL) " }, "businessTelephone": { "type": "array", "items": { "type": "string", "examples": [ "+61 2 9876 5400" ], "maxLength": 30, "description": "(OPTIONAL) " }, "title": "business_telephone", "description": "(OPTIONAL) " }, "emailAddress": { "type": "array", "items": { "type": "string", "examples": [ "john.smith@example.com" ], "maxLength": 100, "format": "email", "description": "(OPTIONAL) " }, "title": "email_address", "description": "(OPTIONAL) " }, "primaryContacts": { "type": "array", "items": { "type": "string", "examples": [ "Sarah Johnson" ], "maxLength": 256, "description": "(OPTIONAL) " }, "title": "primary_contacts", "description": "(OPTIONAL) " }, "website": { "type": "array", "items": { "type": "string", "examples": [ "https://www.example.com" ], "maxLength": 256, "description": "(OPTIONAL) " }, "title": "website", "description": "(OPTIONAL) " }, "registeredBusinessAddresses": { "type": "array", "items": { "$ref": "#/components/schemas/google.type.PostalAddress" }, "title": "registered_business_addresses", "description": "(OPTIONAL) " }, "principalBusinessAddresses": { "type": "array", "items": { "$ref": "#/components/schemas/google.type.PostalAddress" }, "title": "principal_business_addresses", "description": "(OPTIONAL) " }, "residentialAddresses": { "type": "array", "items": { "$ref": "#/components/schemas/google.type.PostalAddress" }, "title": "residential_addresses", "description": "(OPTIONAL) " } }, "title": "ContactInfo", "additionalProperties": false }, "bndry.api.risk.entities.v1alpha.Entity.EntityRelationship": { "type": "object", "properties": { "id": { "type": "string", "title": "id", "readOnly": true }, "sourceEntity": { "type": "string", "examples": [ "entities/john-smith" ], "title": "source_entity", "description": "(OPTIONAL) " }, "targetEntity": { "type": "string", "examples": [ "entities/example-financial-services" ], "title": "target_entity", "description": "(OPTIONAL) " }, "type": { "title": "type", "description": "(OPTIONAL) ", "$ref": "#/components/schemas/bndry.api.risk.entities.v1alpha.RelationshipType" }, "displayName": { "type": "string", "title": "display_name", "readOnly": true }, "entityType": { "type": "string", "title": "entity_type", "readOnly": true } }, "title": "EntityRelationship", "additionalProperties": false }, "bndry.api.risk.entities.v1alpha.Entity.ExternalIds": { "type": "object", "properties": { "cherryhub": { "type": "string", "title": "cherryhub", "maxLength": 255, "description": "(OPTIONAL) CherryHub external identifier." }, "custom": { "type": "object", "title": "custom", "additionalProperties": { "type": "string", "title": "value", "maxLength": 255 }, "description": "(OPTIONAL) Custom external identifiers as key-value pairs." } }, "title": "ExternalIds", "additionalProperties": false, "description": "External ID mappings for an entity." }, "bndry.api.risk.entities.v1alpha.Entity.ExternalIds.CustomEntry": { "type": "object", "properties": { "key": { "type": "string", "title": "key" }, "value": { "type": "string", "title": "value" } }, "title": "CustomEntry", "additionalProperties": false }, "bndry.api.risk.entities.v1alpha.Entity.Individual": { "type": "object", "properties": { "title": { "type": "string", "examples": [ "Mr." ], "title": "title", "maxLength": 25, "description": "(OPTIONAL) Optional. The individual's title, e.g., \"Mr.\", \"Dr.\"." }, "givenName": { "type": "string", "examples": [ "John" ], "title": "given_name", "maxLength": 256, "description": "(OPTIONAL) Optional. The individual's given name." }, "middleName": { "type": "string", "examples": [ "Robert" ], "title": "middle_name", "maxLength": 256, "description": "(OPTIONAL) Optional. The individual's middle name or initial." }, "familyName": { "type": "string", "examples": [ "Smith" ], "title": "family_name", "maxLength": 256, "description": "(OPTIONAL) Optional. The individual's family name." }, "birthDate": { "title": "birth_date", "description": "(OPTIONAL) Optional. The individual's date and time of birth.\nbirth_date.year_range // birth year must be on or after 1900\n", "$ref": "#/components/schemas/google.type.Date" }, "birthPlace": { "type": "string", "examples": [ "Sydney, NSW, Australia" ], "title": "birth_place", "maxLength": 256, "description": "(OPTIONAL) " }, "gender": { "title": "gender", "description": "(OPTIONAL) ", "$ref": "#/components/schemas/bndry.api.risk.entities.v1alpha.Entity.Individual.Gender" }, "nationality": { "type": "string", "examples": [ "AU" ], "title": "nationality", "maxLength": 2, "pattern": "^[A-Z]{2}$", "description": "(OPTIONAL) " }, "residenceCountry": { "type": "string", "examples": [ "AU" ], "title": "residence_country", "maxLength": 2, "pattern": "^[A-Z]{2}$", "description": "(OPTIONAL) " }, "citizenshipCountry": { "type": "array", "items": { "type": "string", "examples": [ "AU" ], "maxLength": 2, "pattern": "^[A-Z]{2}$", "description": "(OPTIONAL) " }, "title": "citizenship_country", "description": "(OPTIONAL) " }, "occupation": { "type": "string", "examples": [ "Senior Financial Analyst" ], "title": "occupation", "maxLength": 256, "description": "(OPTIONAL) " }, "employer": { "type": "string", "examples": [ "Example Financial Services Ltd" ], "title": "employer", "maxLength": 256, "description": "(OPTIONAL) " }, "alias": { "type": "string", "examples": [ "Johnny" ], "title": "alias", "maxLength": 256, "description": "(OPTIONAL) " }, "governmentId": { "type": "object", "title": "government_id", "additionalProperties": { "title": "value", "$ref": "#/components/schemas/bndry.api.risk.entities.v1alpha.Entity.Individual.GovernmentId" }, "description": "(OPTIONAL) " } }, "title": "Individual", "additionalProperties": false }, "bndry.api.risk.entities.v1alpha.Entity.Individual.Gender": { "type": "string", "title": "Gender", "enum": [ "GENDER_UNSPECIFIED", "MALE", "FEMALE", "OTHER" ] }, "bndry.api.risk.entities.v1alpha.Entity.Individual.GovernmentId": { "type": "object", "properties": { "number": { "type": "string", "examples": [ "N1234567" ], "title": "number", "minLength": 1 }, "issuer": { "type": "string", "examples": [ "Service NSW" ], "title": "issuer", "minLength": 1 }, "regionCode": { "type": "string", "examples": [ "NSW" ], "title": "region_code", "minLength": 1 }, "expiryDateTime": { "title": "expiry_date_time", "description": "(OPTIONAL) ", "$ref": "#/components/schemas/google.protobuf.Timestamp" } }, "title": "GovernmentId", "required": [ "number", "issuer", "regionCode" ], "additionalProperties": false }, "bndry.api.risk.entities.v1alpha.Entity.Individual.GovernmentId.GovernmentIdType": { "type": "string", "title": "GovernmentIdType", "enum": [ "GOVERNMENT_ID_TYPE_UNSPECIFIED", "PASSPORT", "DRIVERS_LICENSE", "NATIONAL_ID", "RESIDENCE_PERMIT", "VISA", "OTHER", "MEDICARE" ] }, "bndry.api.risk.entities.v1alpha.Entity.Individual.GovernmentIdEntry": { "type": "object", "properties": { "key": { "type": "string", "title": "key" }, "value": { "title": "value", "$ref": "#/components/schemas/bndry.api.risk.entities.v1alpha.Entity.Individual.GovernmentId" } }, "title": "GovernmentIdEntry", "additionalProperties": false }, "bndry.api.risk.entities.v1alpha.Entity.RegistrationDetails": { "type": "object", "properties": { "value": { "type": "string", "examples": [ "12 345 678 901" ], "title": "value", "description": "(OPTIONAL) " }, "registrationDateTime": { "title": "registration_date_time", "description": "(OPTIONAL) ", "$ref": "#/components/schemas/google.protobuf.Timestamp" }, "regionCode": { "type": "string", "examples": [ "NSW" ], "title": "region_code", "description": "(OPTIONAL) " }, "tradingName": { "type": "string", "examples": [ "Example Financial Services" ], "title": "trading_name", "description": "(OPTIONAL) " }, "registeredName": { "type": "string", "examples": [ "Example Financial Services Pty Ltd" ], "title": "registered_name", "description": "(OPTIONAL) " } }, "title": "RegistrationDetails", "additionalProperties": false }, "bndry.api.risk.entities.v1alpha.Entity.RegistrationEntry": { "type": "object", "properties": { "key": { "type": "string", "title": "key" }, "value": { "title": "value", "$ref": "#/components/schemas/bndry.api.risk.entities.v1alpha.Entity.RegistrationDetails" } }, "title": "RegistrationEntry", "additionalProperties": false }, "bndry.api.risk.entities.v1alpha.Entity.RegistrationType": { "type": "string", "title": "RegistrationType", "enum": [ "REGISTRATION_TYPE_UNSPECIFIED", "ABN", "ACN" ] }, "bndry.api.risk.entities.v1alpha.Entity.RiskDetails": { "type": "object", "properties": { "riskStatus": { "title": "risk_status", "description": "(OPTIONAL) ", "$ref": "#/components/schemas/bndry.api.risk.entities.v1alpha.Entity.RiskDetails.RiskStatus" }, "riskStatusReason": { "title": "risk_status_reason", "description": "(OPTIONAL) ", "$ref": "#/components/schemas/bndry.api.risk.entities.v1alpha.Entity.RiskDetails.RiskStatusReason" }, "riskRating": { "type": "string", "title": "risk_rating", "maxLength": 50, "description": "(OPTIONAL) The risk rating label (e.g., \"LOW\", \"MEDIUM\", \"HIGH\", \"CRITICAL\").\n This is a tenant-configurable value from the RiskRatingLevels resource." } }, "title": "RiskDetails", "additionalProperties": false }, "bndry.api.risk.entities.v1alpha.Entity.RiskDetails.RiskRating": { "type": "string", "title": "RiskRating", "enum": [ "RISK_RATING_UNSPECIFIED", "LOW", "MEDIUM", "HIGH", "CRITICAL" ], "description": "Default risk rating values. Use .String() to get the label for the risk_rating field." }, "bndry.api.risk.entities.v1alpha.Entity.RiskDetails.RiskStatus": { "type": "string", "title": "RiskStatus", "enum": [ "RISK_STATUS_UNSPECIFIED", "ACTIVE", "PENDING_REVIEW", "SUSPENDED", "OFFBOARDED", "INACTIVE" ] }, "bndry.api.risk.entities.v1alpha.Entity.RiskDetails.RiskStatusReason": { "type": "string", "title": "RiskStatusReason", "enum": [ "RISK_STATUS_REASON_UNSPECIFIED", "NA", "SUSPECTED_FRAUD", "CONFIRMED_FRAUD", "NON_COMPLIANCE", "OUTSIDE_RISK_APPETITE", "EXCESSIVE_COMPLAINTS_OR_DISPUTES_CHARGEBACKS", "EXCESSIVE_ACTIVITY_OR_UNPLANNED_CHANGES_IN_VOLUME", "BUSINESS_CLOSED_OR_NO_LONGER_PROVIDING_SERVICES", "OTHER" ] }, "bndry.api.risk.entities.v1alpha.Entity.Trust": { "type": "object", "properties": { "type": { "title": "type", "description": "(OPTIONAL) ", "$ref": "#/components/schemas/bndry.api.risk.entities.v1alpha.Entity.Trust.TrustType" }, "trust": { "type": "string", "examples": [ "Smith Family Trust" ], "title": "trust", "maxLength": 256, "description": "(OPTIONAL) " }, "settler": { "type": "string", "examples": [ "John Robert Smith" ], "title": "settler", "maxLength": 256, "description": "(OPTIONAL) " }, "trustee": { "type": "string", "examples": [ "Example Trust Services Pty Ltd" ], "title": "trustee", "maxLength": 256, "description": "(OPTIONAL) " }, "deed": { "type": "string", "examples": [ "Smith Family Trust Deed 2024" ], "title": "deed", "maxLength": 256, "description": "(OPTIONAL) " } }, "title": "Trust", "additionalProperties": false }, "bndry.api.risk.entities.v1alpha.Entity.Trust.TrustType": { "type": "string", "title": "TrustType", "enum": [ "TRUST_TYPE_UNSPECIFIED", "SPECIAL_DISABILITY", "DECEASED_ESTATE", "HYBRID_TRUST", "FIXED_TRUST", "DISCRETIONARY_TRUST", "CASH_MANAGEMENT_UNIT_TRUST", "PUBLIC_UNIT_TRUST", "FIXED_UNIT_TRUST" ] }, "bndry.api.risk.entities.v1alpha.EntityEvaluationInput": { "type": "object", "properties": { "entity": { "title": "entity", "$ref": "#/components/schemas/bndry.api.risk.entities.v1alpha.Entity" }, "activityLogs": { "type": "array", "items": { "$ref": "#/components/schemas/bndry.api.risk.entities.v1alpha.ActivityLog" }, "title": "activity_logs" } }, "title": "EntityEvaluationInput", "additionalProperties": false }, "bndry.api.risk.entities.v1alpha.EntityType": { "type": "string", "title": "EntityType", "enum": [ "ENTITY_TYPE_UNSPECIFIED", "INDIVIDUAL", "COMPANY", "TRUST" ] }, "bndry.api.risk.entities.v1alpha.EvaluateEntityRequest": { "type": "object", "properties": { "name": { "type": "string", "examples": [ "entities/john-smith-001" ], "title": "name", "description": "correct_name_format // name must start with 'entities/'\n" } }, "title": "EvaluateEntityRequest", "required": [ "name" ], "additionalProperties": false }, "bndry.api.risk.entities.v1alpha.EvaluateEntityResponse": { "type": "object", "properties": { "activityLog": { "title": "activity_log", "$ref": "#/components/schemas/bndry.api.risk.entities.v1alpha.ActivityLog" } }, "title": "EvaluateEntityResponse", "additionalProperties": false }, "bndry.api.risk.entities.v1alpha.Evidence": { "type": "object", "properties": { "evidenceId": { "type": [ "string", "null" ], "title": "evidence_id", "description": "A unique identifier for this evidence document. Used to cross-reference from PEP entries,\n sanction events, and other records via their evidence_ids fields.", "readOnly": true }, "title": { "type": [ "string", "null" ], "title": "title", "description": "The title or headline of the source document.", "readOnly": true }, "uri": { "type": [ "string", "null" ], "title": "uri", "description": "A URI linking to the original source article or document.", "readOnly": true }, "assetUri": { "type": [ "string", "null" ], "title": "asset_uri", "description": "A URI to an archived or cached version of the source.", "readOnly": true }, "summary": { "type": [ "string", "null" ], "title": "summary", "description": "A brief text snippet or excerpt from the source. For copyrighted evidence, only a summary\n snippet is provided.", "readOnly": true }, "keywords": { "type": [ "string", "null" ], "title": "keywords", "description": "Comma-separated keywords associated with this evidence.", "readOnly": true }, "languageCode": { "type": [ "string", "null" ], "title": "language_code", "description": "Language of the source document (ISO 639-3 code).", "readOnly": true }, "credibility": { "oneOf": [ { "$ref": "#/components/schemas/bndry.api.risk.entities.v1alpha.EvidenceCredibility" }, { "type": "null" } ], "title": "credibility", "description": "An assessment of the source's credibility.", "readOnly": true }, "copyrighted": { "type": [ "boolean", "null" ], "title": "copyrighted", "description": "Indicates whether the source is protected under copyright laws.", "readOnly": true }, "captureTime": { "oneOf": [ { "$ref": "#/components/schemas/google.protobuf.Timestamp" }, { "type": "null" } ], "title": "capture_time", "description": "The timestamp when this evidence was captured or archived.", "readOnly": true }, "publicationTime": { "oneOf": [ { "$ref": "#/components/schemas/google.protobuf.Timestamp" }, { "type": "null" } ], "title": "publication_time", "description": "The original publication timestamp of the source article or document.", "readOnly": true }, "datasets": { "type": "array", "items": { "$ref": "#/components/schemas/bndry.api.risk.entities.v1alpha.DatasetTag" }, "title": "datasets", "description": "Classification tags indicating which risk categories this evidence supports (e.g., PEP,\n sanctions, reputational risk).", "readOnly": true } }, "title": "Evidence", "additionalProperties": false, "description": "A supporting evidence document or source that substantiates the risk information. Evidence items\n are referenced by their evidence_id from PEP entries, sanction events, and other records within\n a match." }, "bndry.api.risk.entities.v1alpha.EvidenceCredibility": { "type": "string", "title": "EvidenceCredibility", "enum": [ "EVIDENCE_CREDIBILITY_UNSPECIFIED", "EVIDENCE_CREDIBILITY_LOW", "EVIDENCE_CREDIBILITY_MEDIUM", "EVIDENCE_CREDIBILITY_HIGH" ], "description": "An assessment of the reliability and trustworthiness of a source document." }, "bndry.api.risk.entities.v1alpha.ExecutionInfo": { "type": "object", "properties": { "activityLogNames": { "type": "array", "items": { "type": "string" }, "title": "activity_log_names", "description": "Resource names of activity logs created during this job execution.\n Format: activityLogs/{activity_log}" } }, "title": "ExecutionInfo", "additionalProperties": false, "description": "Common execution information across jobs" }, "bndry.api.risk.entities.v1alpha.FormCreatedActivityLog": { "type": "object", "properties": { "formId": { "type": "string", "title": "form_id", "minLength": 1, "description": "Required. The ID of the form that was created." }, "formDisplayName": { "type": "string", "examples": [ "KYC Identity Verification - Jane Smith" ], "title": "form_display_name", "minLength": 1, "description": "Required. The display name of the Form specified" } }, "title": "FormCreatedActivityLog", "required": [ "formId", "formDisplayName" ], "additionalProperties": false }, "bndry.api.risk.entities.v1alpha.GamblingRiskEntry": { "type": "object", "properties": { "evidenceId": { "type": [ "string", "null" ], "title": "evidence_id", "description": "A unique identifier for the associated evidence.", "readOnly": true }, "title": { "type": [ "string", "null" ], "title": "title", "description": "Title of the risk intelligence item.", "readOnly": true }, "summary": { "type": [ "string", "null" ], "title": "summary", "description": "Summary of the risk intelligence.", "readOnly": true }, "keywords": { "type": [ "string", "null" ], "title": "keywords", "description": "Keywords associated with this entry.", "readOnly": true } }, "title": "GamblingRiskEntry", "additionalProperties": false, "description": "A gambling risk intelligence entry." }, "bndry.api.risk.entities.v1alpha.Gender": { "type": "string", "title": "Gender", "enum": [ "GENDER_UNSPECIFIED", "GENDER_MALE", "GENDER_FEMALE" ], "description": "Gender of an individual." }, "bndry.api.risk.entities.v1alpha.GetActivityLogRequest": { "type": "object", "properties": { "name": { "type": "string", "examples": [ "activityLogs/01234567-89ab-cdef-0123-456789abcdef" ], "title": "name", "description": "Required. The resource name of the activity to retrieve.\n Format: activityLog/{activity_log}\ncorrect_name_format // name must start with 'activityLogs/'\n" } }, "title": "GetActivityLogRequest", "required": [ "name" ], "additionalProperties": false, "description": "Request message for [EntityService.GetActivityLog][bndry.api.risk.v1alpha.EntityService.GetActivityLog]." }, "bndry.api.risk.entities.v1alpha.GetActivityLogTypeRequest": { "type": "object", "properties": { "name": { "type": "string", "examples": [ "activityLogTypes/customer-sign-in" ], "title": "name", "minLength": 1, "description": "Required. The name of the activity log type to retrieve.\n Format: activityLogTypes/{activity_log_type}" } }, "title": "GetActivityLogTypeRequest", "required": [ "name" ], "additionalProperties": false }, "bndry.api.risk.entities.v1alpha.GetEntityEvaluationInputRequest": { "type": "object", "properties": { "name": { "type": "string", "examples": [ "entities/john-smith-001" ], "title": "name", "description": "correct_name_format // name must start with 'entities/'\n" } }, "title": "GetEntityEvaluationInputRequest", "required": [ "name" ], "additionalProperties": false }, "bndry.api.risk.entities.v1alpha.GetEntityEvaluationInputResponse": { "type": "object", "properties": { "input": { "title": "input", "$ref": "#/components/schemas/bndry.api.risk.entities.v1alpha.EntityEvaluationInput" } }, "title": "GetEntityEvaluationInputResponse", "additionalProperties": false }, "bndry.api.risk.entities.v1alpha.GetEntityRequest": { "type": "object", "properties": { "name": { "type": "string", "examples": [ "entities/john-smith-001" ], "title": "name", "description": "Required. The resource name of the entity to retrieve.\n Format: entities/{entity}\n For external ID lookup, use format: entities/{external_id}?system={external_system}\n Examples:\n - entities/john-smith-001 (direct lookup)\n - entities/12345?system=salesforce (external ID lookup)\ncorrect_name_format // name must start with 'entities/'\nno_wildcards // name must not contain wildcards\n" }, "system": { "type": "string", "examples": [ "salesforce" ], "title": "system", "description": "(OPTIONAL) Optional. External system identifier for external ID lookup.\n When provided, the entity ID in name is treated as an external ID." } }, "title": "GetEntityRequest", "required": [ "name" ], "additionalProperties": false, "description": "Request message for [EntityService.GetEntity][bndry.api.risk.v1alpha.EntityService.GetEntity]." }, "bndry.api.risk.entities.v1alpha.GetIndividualEntityRiskRatingJobRequest": { "type": "object", "properties": { "name": { "type": "string", "examples": [ "entities/-/individualEntityRiskRatingJobs/pep-sanction-screen-001" ], "title": "name", "description": "Required. The resource name of the job to retrieve.\n Format: entities/-/individualEntityRiskRatingJobs/{individual_entity_risk_rating_job}\ncorrect_name_format // name must follow format 'entities/-/individualEntityRiskRatingJobs/*'\n" } }, "title": "GetIndividualEntityRiskRatingJobRequest", "required": [ "name" ], "additionalProperties": false, "description": "Request message for [GetIndividualEntityRiskRatingJob][hawk.v1alpha.IndividualEntityRiskRatingJobService.GetIndividualEntityRiskRatingJob]." }, "bndry.api.risk.entities.v1alpha.GetIndividualEntityVerificationJobRequest": { "type": "object", "properties": { "name": { "type": "string", "examples": [ "individualEntityVerificationJobs/verification-001" ], "title": "name", "description": "Required. The resource name of the job to retrieve.\n Format: individualEntityVerificationJobs/{individual_entity_verification_job}\ncorrect_name_format // name must follow format 'individualEntityVerificationJobs/*'\n" } }, "title": "GetIndividualEntityVerificationJobRequest", "required": [ "name" ], "additionalProperties": false, "description": "Request message for [GetIndividualEntityVerificationJob][bndry.api.risk.entities.v1alpha.IndividualEntityVerificationJobService.GetIndividualEntityVerificationJob]." }, "bndry.api.risk.entities.v1alpha.GetOnboardIndividualEntityJobRequest": { "type": "object", "properties": { "name": { "type": "string", "examples": [ "entities/-/onboardIndividualEntityJobs/kyc-individual-mfs-001" ], "title": "name", "description": "Required. The resource name of the job to retrieve.\n Format: entities/-/onboardIndividualEntityJobs/{onboard_individual_entity_job}\ncorrect_name_format // name must follow format 'entities/-/onboardIndividualEntityJobs/*'\n" } }, "title": "GetOnboardIndividualEntityJobRequest", "required": [ "name" ], "additionalProperties": false, "description": "Request message for [GetOnboardIndividualEntityJob][bndry.api.risk.entities.v1alpha.OnboardIndividualEntityJobService.GetOnboardIndividualEntityJob]." }, "bndry.api.risk.entities.v1alpha.GetOperationRequest": { "type": "object", "properties": { "name": { "type": "string", "title": "name", "description": "The name of the operation resource.\n The format depends on the specific job type:\n - OnboardIndividualEntityJob: entities/-/onboardIndividualEntityJobs/{job}/operations/{operation}\n - IndividualEntityVerificationJob: individualEntityVerificationJobs/{job}/operations/{operation}\n - KybProfileGenerationJob: kybProfileGenerationJobs/{job}/operations/{operation}" } }, "title": "GetOperationRequest", "required": [ "name" ], "additionalProperties": false, "description": "Request message for getting the status of a long-running operation, used by job services to poll operation results." }, "bndry.api.risk.entities.v1alpha.GetPepSanctionBusinessEntityJobRequest": { "type": "object", "properties": { "name": { "type": "string", "examples": [ "pepSanctionBusinessEntityJobs/pep-sanction-screen-001" ], "title": "name", "description": "Required. The resource name of the job to retrieve.\n Format: pepSanctionBusinessEntityJobs/{pep_sanction_business_entity_job}\ncorrect_name_format // name must follow format 'pepSanctionBusinessEntityJobs/*'\n" } }, "title": "GetPepSanctionBusinessEntityJobRequest", "required": [ "name" ], "additionalProperties": false, "description": "Request message for [GetPepSanctionBusinessEntityJob][bndry.api.risk.entities.v1alpha.PepSanctionBusinessEntityJobService.GetPepSanctionBusinessEntityJob]." }, "bndry.api.risk.entities.v1alpha.GetPepSanctionIndividualEntityJobRequest": { "type": "object", "properties": { "name": { "type": "string", "examples": [ "entities/-/pepSanctionIndividualEntityJobs/pep-sanction-screen-001" ], "title": "name", "description": "Required. The resource name of the job to retrieve.\n Format: entities/-/pepSanctionIndividualEntityJobs/{pep_sanction_individual_entity_job}\ncorrect_name_format // name must follow format 'entities/-/pepSanctionIndividualEntityJobs/*'\n" } }, "title": "GetPepSanctionIndividualEntityJobRequest", "required": [ "name" ], "additionalProperties": false, "description": "Request message for [GetPepSanctionIndividualEntityJob][bndry.api.risk.entities.v1alpha.PepSanctionIndividualEntityJobService.GetPepSanctionIndividualEntityJob]." }, "bndry.api.risk.entities.v1alpha.HardDeleteEntityRequest": { "type": "object", "properties": { "name": { "type": "string", "examples": [ "entities/example-financial-services" ], "title": "name", "description": "Required. The resource name of the entity to hard delete.\n Format: entities/{entity}" } }, "title": "HardDeleteEntityRequest", "required": [ "name" ], "additionalProperties": false, "description": "Request message for [bndry.api.risk.v1alpha.EntityService.HardDeleteEntity]." }, "bndry.api.risk.entities.v1alpha.Identifier": { "type": "object", "properties": { "category": { "type": "string", "title": "category", "description": "The type of identifier, such as passport, national_id, ssn, or tax_id.", "readOnly": true }, "value": { "type": "string", "title": "value", "description": "The value of the identifier (e.g., the passport number).", "readOnly": true } }, "title": "Identifier", "additionalProperties": false, "description": "A personal identification document or number associated with the individual." }, "bndry.api.risk.entities.v1alpha.IdentityResearchActivityLog": { "type": "object", "properties": { "result": { "title": "result", "description": "The structured research result.", "readOnly": true, "$ref": "#/components/schemas/bndry.api.risk.entities.v1alpha.IdentityResearchResult" }, "tokenUsage": { "title": "token_usage", "readOnly": true, "$ref": "#/components/schemas/bndry.api.risk.entities.v1alpha.TokenUsage" } }, "title": "IdentityResearchActivityLog", "additionalProperties": false, "description": "Activity log payload for identity research results." }, "bndry.api.risk.entities.v1alpha.IdentityResearchAdverseFinding": { "type": "object", "properties": { "description": { "type": "string", "title": "description", "readOnly": true }, "occurrenceDate": { "title": "occurrence_date", "readOnly": true, "$ref": "#/components/schemas/google.type.Date" }, "proceduralStatus": { "type": "string", "title": "procedural_status", "readOnly": true }, "evidenceType": { "type": "string", "title": "evidence_type", "readOnly": true }, "subjectDenial": { "type": "string", "title": "subject_denial", "readOnly": true }, "sourceIds": { "type": "array", "items": { "type": "string", "readOnly": true }, "title": "source_ids", "readOnly": true } }, "title": "IdentityResearchAdverseFinding", "additionalProperties": false }, "bndry.api.risk.entities.v1alpha.IdentityResearchCoverageConfirmation": { "type": "object", "properties": { "researchArea": { "type": "string", "title": "research_area", "readOnly": true }, "searched": { "type": "string", "title": "searched", "readOnly": true }, "resultsFound": { "type": "integer", "title": "results_found", "format": "int32", "readOnly": true } }, "title": "IdentityResearchCoverageConfirmation", "additionalProperties": false }, "bndry.api.risk.entities.v1alpha.IdentityResearchCriminalAssociation": { "type": "object", "properties": { "associatedEntityOrGroup": { "type": "string", "title": "associated_entity_or_group", "readOnly": true }, "relationshipType": { "type": "string", "title": "relationship_type", "readOnly": true }, "sourceIds": { "type": "array", "items": { "type": "string", "readOnly": true }, "title": "source_ids", "readOnly": true } }, "title": "IdentityResearchCriminalAssociation", "additionalProperties": false }, "bndry.api.risk.entities.v1alpha.IdentityResearchExcludedLookalike": { "type": "object", "properties": { "nameFound": { "type": "string", "title": "name_found", "readOnly": true }, "conflictReason": { "type": "string", "title": "conflict_reason", "readOnly": true }, "sourceIds": { "type": "array", "items": { "type": "string", "readOnly": true }, "title": "source_ids", "readOnly": true } }, "title": "IdentityResearchExcludedLookalike", "additionalProperties": false }, "bndry.api.risk.entities.v1alpha.IdentityResearchNeutralPublicRecord": { "type": "object", "properties": { "recordType": { "type": "string", "title": "record_type", "readOnly": true }, "description": { "type": "string", "title": "description", "readOnly": true }, "sourceIds": { "type": "array", "items": { "type": "string", "readOnly": true }, "title": "source_ids", "readOnly": true } }, "title": "IdentityResearchNeutralPublicRecord", "additionalProperties": false }, "bndry.api.risk.entities.v1alpha.IdentityResearchPEPAssociation": { "type": "object", "properties": { "associatedEntity": { "type": "string", "title": "associated_entity", "readOnly": true }, "relationshipType": { "type": "string", "title": "relationship_type", "readOnly": true }, "associatedPepRole": { "type": "string", "title": "associated_pep_role", "readOnly": true }, "sourceIds": { "type": "array", "items": { "type": "string", "readOnly": true }, "title": "source_ids", "readOnly": true } }, "title": "IdentityResearchPEPAssociation", "additionalProperties": false }, "bndry.api.risk.entities.v1alpha.IdentityResearchPEPStatus": { "type": "object", "properties": { "identified": { "type": "string", "title": "identified", "readOnly": true }, "tier": { "type": "integer", "title": "tier", "format": "int32", "readOnly": true }, "role": { "type": "string", "title": "role", "readOnly": true }, "authority": { "type": "string", "title": "authority", "readOnly": true }, "jurisdiction": { "type": "string", "title": "jurisdiction", "readOnly": true }, "dates": { "type": "string", "title": "dates", "readOnly": true }, "sourceIds": { "type": "array", "items": { "type": "string", "readOnly": true }, "title": "source_ids", "readOnly": true } }, "title": "IdentityResearchPEPStatus", "additionalProperties": false }, "bndry.api.risk.entities.v1alpha.IdentityResearchResult": { "type": "object", "properties": { "executiveSummary": { "type": "string", "title": "executive_summary", "description": "Concise summary of findings.", "readOnly": true }, "adverseFindings": { "type": "array", "items": { "$ref": "#/components/schemas/bndry.api.risk.entities.v1alpha.IdentityResearchAdverseFinding" }, "title": "adverse_findings", "description": "Adverse findings ordered chronologically.", "readOnly": true }, "pepStatus": { "title": "pep_status", "description": "PEP classification.", "readOnly": true, "$ref": "#/components/schemas/bndry.api.risk.entities.v1alpha.IdentityResearchPEPStatus" }, "pepAssociations": { "type": "array", "items": { "$ref": "#/components/schemas/bndry.api.risk.entities.v1alpha.IdentityResearchPEPAssociation" }, "title": "pep_associations", "description": "Associations with PEPs.", "readOnly": true }, "criminalAssociations": { "type": "array", "items": { "$ref": "#/components/schemas/bndry.api.risk.entities.v1alpha.IdentityResearchCriminalAssociation" }, "title": "criminal_associations", "description": "Associations with criminal groups or personalities.", "readOnly": true }, "neutralPublicRecords": { "type": "array", "items": { "$ref": "#/components/schemas/bndry.api.risk.entities.v1alpha.IdentityResearchNeutralPublicRecord" }, "title": "neutral_public_records", "description": "Non-adverse public records.", "readOnly": true }, "excludedLookalikes": { "type": "array", "items": { "$ref": "#/components/schemas/bndry.api.risk.entities.v1alpha.IdentityResearchExcludedLookalike" }, "title": "excluded_lookalikes", "description": "Excluded lookalike results.", "readOnly": true }, "coverageConfirmation": { "type": "array", "items": { "$ref": "#/components/schemas/bndry.api.risk.entities.v1alpha.IdentityResearchCoverageConfirmation" }, "title": "coverage_confirmation", "description": "Coverage confirmation audit trail.", "readOnly": true }, "sources": { "type": "array", "items": { "$ref": "#/components/schemas/bndry.api.risk.entities.v1alpha.IdentityResearchSource" }, "title": "sources", "description": "Centralised source ledger.", "readOnly": true } }, "title": "IdentityResearchResult", "additionalProperties": false, "description": "Structured result from an identity research task." }, "bndry.api.risk.entities.v1alpha.IdentityResearchSource": { "type": "object", "properties": { "sourceId": { "type": "string", "title": "source_id", "readOnly": true }, "url": { "type": "string", "title": "url", "readOnly": true }, "title": { "type": "string", "title": "title", "readOnly": true }, "publisher": { "type": "string", "title": "publisher", "readOnly": true }, "publishDate": { "title": "publish_date", "readOnly": true, "$ref": "#/components/schemas/google.type.Date" }, "snippet": { "type": "string", "title": "snippet", "readOnly": true } }, "title": "IdentityResearchSource", "additionalProperties": false }, "bndry.api.risk.entities.v1alpha.IndividualEntityRiskRatingJob": { "type": "object", "properties": { "name": { "type": "string", "examples": [ "entities/-/individualEntityRiskRatingJobs/risk-rating-2024-0127-743891" ], "title": "name", "description": "(IDENTIFIER) Output only. The resource name of the job.\n Format: entities/-/individualEntityRiskRatingJobs/{individual_entity_risk_rating_job}\ncorrect_name_format // name must follow format 'entities/-/individualEntityRiskRatingJobs/*'\n" }, "createTime": { "title": "create_time", "description": "Output only. The timestamp when the job was created.", "readOnly": true, "$ref": "#/components/schemas/google.protobuf.Timestamp" }, "updateTime": { "title": "update_time", "description": "Output only. The timestamp when the job was most recently updated.", "readOnly": true, "$ref": "#/components/schemas/google.protobuf.Timestamp" } }, "title": "IndividualEntityRiskRatingJob", "additionalProperties": false, "description": "Represents a job for performing risk rating on individual entities." }, "bndry.api.risk.entities.v1alpha.IndividualEntityVerificationJob": { "type": "object", "properties": { "name": { "type": "string", "examples": [ "individualEntityVerificationJobs/verification-job-2024-0127-kycind-743891" ], "title": "name", "description": "(IDENTIFIER) Output only. The resource name of the job.\n Format: individualEntityVerificationJobs/{individual_entity_verification_job}\ncorrect_name_format // name must follow format 'individualEntityVerificationJobs/*'\n" }, "providerConfig": { "title": "provider_config", "description": "Required. The configuration for the provider to use to perform the verification.", "$ref": "#/components/schemas/bndry.api.risk.entities.v1alpha.ProviderConfig" }, "enrichEntity": { "type": "boolean", "title": "enrich_entity", "description": "(OPTIONAL) Optional. If true, entity will be enriched by verification response." }, "webhookUri": { "type": "string", "examples": [ "https://api.example.com/webhooks/onboarding/individual/entity-job-status" ], "title": "webhook_uri", "maxLength": 2048, "format": "uri", "description": "(OPTIONAL) Optional. Webhook target URI for notifications." }, "createTime": { "title": "create_time", "description": "Output only. The timestamp when the job was created.", "readOnly": true, "$ref": "#/components/schemas/google.protobuf.Timestamp" }, "updateTime": { "title": "update_time", "description": "Output only. The timestamp when the job was most recently updated.", "readOnly": true, "$ref": "#/components/schemas/google.protobuf.Timestamp" } }, "title": "IndividualEntityVerificationJob", "required": [ "providerConfig" ], "additionalProperties": false }, "bndry.api.risk.entities.v1alpha.IndividualName": { "type": "object", "properties": { "fullName": { "type": [ "string", "null" ], "title": "full_name", "description": "The complete name as a single string. Only populated when the screening provider supplies\n a single unstructured name string without individual components.", "readOnly": true }, "givenName": { "type": [ "string", "null" ], "title": "given_name", "description": "The individual's given name.", "readOnly": true }, "middleName": { "type": [ "string", "null" ], "title": "middle_name", "description": "The individual's middle name or names.", "readOnly": true }, "familyName": { "type": [ "string", "null" ], "title": "family_name", "description": "The individual's family name.", "readOnly": true } }, "title": "IndividualName", "additionalProperties": false, "description": "A reusable person name with structured components.\n When structured name parts (given_name, middle_name, family_name) are available,\n full_name will not be populated. full_name is only set when the screening provider supplies\n a single unstructured name string without individual components." }, "bndry.api.risk.entities.v1alpha.InsolvencyEntry": { "type": "object", "properties": { "type": { "type": [ "string", "null" ], "title": "type", "description": "The type of insolvency (e.g., \"Liquidation\", \"Administration\", \"Receivership\").", "readOnly": true }, "caseNumber": { "type": [ "string", "null" ], "title": "case_number", "description": "An official case or reference number for the insolvency.", "readOnly": true }, "court": { "type": [ "string", "null" ], "title": "court", "description": "The court handling the insolvency proceedings.", "readOnly": true }, "startDate": { "oneOf": [ { "$ref": "#/components/schemas/google.type.Date" }, { "type": "null" } ], "title": "start_date", "description": "Start date of the insolvency.", "readOnly": true }, "endDate": { "oneOf": [ { "$ref": "#/components/schemas/google.type.Date" }, { "type": "null" } ], "title": "end_date", "description": "End date of the insolvency (if resolved).", "readOnly": true }, "evidenceIds": { "type": "array", "items": { "type": "string", "readOnly": true }, "title": "evidence_ids", "description": "References to supporting evidence documents.", "readOnly": true } }, "title": "InsolvencyEntry", "additionalProperties": false, "description": "An insolvency or bankruptcy record for the business entity." }, "bndry.api.risk.entities.v1alpha.ListActivityLogTypeRequest": { "type": "object", "properties": { "pageSize": { "type": "integer", "examples": [ 25 ], "title": "page_size", "format": "int32", "description": "(OPTIONAL) Optional. The maximum number of activity log types to return. The service may return fewer than\n this value.\n If unspecified, at most 50 activity log types will be returned.\n The maximum value is 1000; values above 1000 will be coerced to 1000." }, "pageToken": { "type": "string", "examples": [ "ChAIAhABGAE" ], "title": "page_token", "description": "(OPTIONAL) Optional. A page token, received from a previous `ListActivityLogType` call.\n Provide this to retrieve the subsequent page.\n When paginating, all other parameters provided to `ListActivityLogType` must\n match the call that provided the page token." }, "showDeleted": { "type": "boolean", "title": "show_deleted", "description": "(OPTIONAL) Optional. If true, soft-deleted activity log types will be included in the response.\n See AIP-164." }, "skip": { "type": "integer", "examples": [ 50 ], "title": "skip", "format": "int32", "description": "(OPTIONAL) Optional. The number of activity log types to skip before starting to collect the result set." }, "filter": { "type": "string", "examples": [ "Customer Sign in" ], "title": "filter", "description": "(OPTIONAL) Optional. A filter expression that filters the results listed in the response.\n Filter only currently supports a fuzzy search on display name.\n See AIP-160 for more details." }, "orderBy": { "type": "string", "examples": [ "name desc" ], "title": "order_by", "description": "(OPTIONAL) " } }, "title": "ListActivityLogTypeRequest", "additionalProperties": false }, "bndry.api.risk.entities.v1alpha.ListActivityLogTypeResponse": { "type": "object", "properties": { "activityLogTypes": { "type": "array", "items": { "$ref": "#/components/schemas/bndry.api.risk.entities.v1alpha.ActivityLogType" }, "title": "activity_log_types" }, "nextPageToken": { "type": "string", "title": "next_page_token", "description": "A token to retrieve the next page of results." }, "totalSize": { "type": "integer", "title": "total_size", "format": "int32", "description": "The total number of activity log types." } }, "title": "ListActivityLogTypeResponse", "additionalProperties": false }, "bndry.api.risk.entities.v1alpha.ListActivityLogsRequest": { "type": "object", "properties": { "parent": { "type": "string", "examples": [ "entities/john-smith-001" ], "title": "parent", "description": "Required. The resource name of the entity for which to list activities.\n Format: entities/{entity}\ncorrect_parent_format // parent must start with 'entities/'\n" }, "pageSize": { "type": "integer", "examples": [ 25 ], "title": "page_size", "format": "int32", "description": "(OPTIONAL) Optional. The maximum number of activities to return. The service may return fewer than\n this value.\n If unspecified, at most 50 activities will be returned.\n The maximum value is 1000; values above 1000 will be coerced to 1000." }, "pageToken": { "type": "string", "examples": [ "ChAIAhABGAE" ], "title": "page_token", "description": "(OPTIONAL) Optional. A page token, received from a previous `ListEntityActivities` call.\n Provide this to retrieve the subsequent page.\n When paginating, all other parameters provided to `ListEntityActivities` must\n match the call that provided the page token." }, "skip": { "type": "integer", "examples": [ 0 ], "title": "skip", "format": "int32", "description": "(OPTIONAL) Optional. The number of resources to skip over before returning resources.\n Default is 0. See: https://google.aip.dev/158#skipping-results" }, "orderBy": { "type": "string", "examples": [ "occurredTime desc" ], "title": "order_by", "description": "(OPTIONAL) " }, "filter": { "type": "string", "title": "filter", "description": "(OPTIONAL) Optional. A filter expression that filters the results listed in the response." }, "showDeleted": { "type": "boolean", "title": "show_deleted", "description": "(OPTIONAL) Optional. If true, soft-deleted activity logs will be included in the response.\n See AIP-164." } }, "title": "ListActivityLogsRequest", "required": [ "parent" ], "additionalProperties": false, "description": "Request message for [EntityService.ListEntityActivities][bndry.api.risk.v1alpha.EntityService.ListEntityActivities]." }, "bndry.api.risk.entities.v1alpha.ListActivityLogsResponse": { "type": "object", "properties": { "activityLogs": { "type": "array", "items": { "$ref": "#/components/schemas/bndry.api.risk.entities.v1alpha.ActivityLog" }, "title": "activity_logs", "description": "The list of activities." }, "nextPageToken": { "type": "string", "examples": [ "ChAIAhABGAE" ], "title": "next_page_token", "description": "A token to retrieve the next page of results, or empty if there are no\n more results in the list." }, "totalSize": { "type": "integer", "examples": [ 127 ], "title": "total_size", "format": "int32", "description": "The total number of entities matching the request." } }, "title": "ListActivityLogsResponse", "additionalProperties": false, "description": "Response message for [EntityService.ListEntityActivities][bndry.api.risk.v1alpha.EntityService.ListEntityActivities]." }, "bndry.api.risk.entities.v1alpha.ListCountriesRequest": { "type": "object", "properties": { "pageSize": { "type": "integer", "examples": [ 50 ], "title": "page_size", "format": "int32", "description": "(OPTIONAL) Optional. The maximum number of countries to return. The service may return fewer than\n this value.\n If unspecified, at most 50 countries will be returned.\n The maximum value is 1000; values above 1000 will be coerced to 1000." }, "pageToken": { "type": "string", "examples": [ "ChAIAhABGAE" ], "title": "page_token", "description": "(OPTIONAL) Optional. A page token, received from a previous `ListCountries` call.\n Provide this to retrieve the subsequent page.\n When paginating, all other parameters provided to `ListCountries` must\n match the call that provided the page token." } }, "title": "ListCountriesRequest", "additionalProperties": false, "description": "Request message for [EntityService.ListCountries][bndry.api.risk.v1alpha.EntityService.ListCountries]." }, "bndry.api.risk.entities.v1alpha.ListCountriesResponse": { "type": "object", "properties": { "countries": { "type": "array", "items": { "$ref": "#/components/schemas/bndry.api.reference.geography.v1alpha.Country" }, "title": "countries", "description": "The list of countries." }, "nextPageToken": { "type": "string", "examples": [ "ChAIAhABGAE" ], "title": "next_page_token", "description": "A token to retrieve the next page of results, or empty if there are no\n more results in the list." }, "totalSize": { "type": "integer", "examples": [ 249 ], "title": "total_size", "format": "int32", "description": "The total number of countries matching the request." } }, "title": "ListCountriesResponse", "additionalProperties": false, "description": "Response message for [EntityService.ListCountries][bndry.api.risk.v1alpha.EntityService.ListCountries]." }, "bndry.api.risk.entities.v1alpha.ListEntitiesRequest": { "type": "object", "properties": { "pageSize": { "type": "integer", "examples": [ 25 ], "title": "page_size", "format": "int32", "description": "(OPTIONAL) Optional. The maximum number of entities to return. The service may return fewer than\n this value.\n If unspecified, at most 50 entities will be returned.\n The maximum value is 1000; values above 1000 will be coerced to 1000." }, "pageToken": { "type": "string", "examples": [ "ChAIAhABGAE" ], "title": "page_token", "description": "(OPTIONAL) Optional. A page token, received from a previous `ListEntities` call.\n Provide this to retrieve the subsequent page.\n When paginating, all other parameters provided to `ListEntities` must\n match the call that provided the page token." }, "showDeleted": { "type": "boolean", "title": "show_deleted", "description": "(OPTIONAL) Optional. If true, soft-deleted entities will be included in the response.\n See AIP-164." }, "skip": { "type": "integer", "examples": [ 50 ], "title": "skip", "format": "int32", "description": "(OPTIONAL) Optional. The number of entities to skip before starting to collect the result set." }, "filter": { "type": "string", "examples": [ "John Smith" ], "title": "filter", "description": "(OPTIONAL) Optional. A filter expression that filters the results listed in the response.\n Filter only currently supports a fuzzy search on display name.\n See AIP-160 for more details." }, "orderBy": { "type": "string", "examples": [ "displayName desc" ], "title": "order_by", "description": "(OPTIONAL) " } }, "title": "ListEntitiesRequest", "additionalProperties": false, "description": "Request message for [EntityService.ListEntities][bndry.api.risk.v1alpha.EntityService.ListEntities]." }, "bndry.api.risk.entities.v1alpha.ListEntitiesResponse": { "type": "object", "properties": { "entities": { "type": "array", "items": { "$ref": "#/components/schemas/bndry.api.risk.entities.v1alpha.Entity" }, "title": "entities", "description": "The list of entities." }, "nextPageToken": { "type": "string", "examples": [ "ChAIAhABGAE" ], "title": "next_page_token", "description": "A token to retrieve the next page of results, or empty if there are no\n more results in the list." }, "totalSize": { "type": "integer", "examples": [ 127 ], "title": "total_size", "format": "int32", "description": "The total number of entities matching the request." } }, "title": "ListEntitiesResponse", "additionalProperties": false, "description": "Response message for [EntityService.ListEntities][bndry.api.risk.v1alpha.EntityService.ListEntities]." }, "bndry.api.risk.entities.v1alpha.ListFilesRequest": { "type": "object", "properties": { "parent": { "type": "string", "examples": [ "entities/john-smith-001" ], "title": "parent", "description": "Required. The parent entity for which to list documents.\n Format: entities/{entity}" }, "pageSize": { "type": "integer", "examples": [ 25 ], "title": "page_size", "format": "int32", "description": "(OPTIONAL) Optional. The maximum number of files to return. The service may return fewer than\n this value.\n If unspecified, at most 50 entities will be returned.\n The maximum value is 1000; values above 1000 will be coerced to 1000." }, "pageToken": { "type": "string", "examples": [ "ChAIAhABGAE" ], "title": "page_token", "description": "(OPTIONAL) Optional. A page token, received from a previous `ListFiles` call.\n Provide this to retrieve the subsequent page.\n When paginating, all other parameters provided to `ListFiles` must\n match the call that provided the page token." }, "showDeleted": { "type": "boolean", "title": "show_deleted", "description": "(OPTIONAL) Optional. If true, soft-deleted files will be included in the response.\n See AIP-164." }, "skip": { "type": "integer", "examples": [ 50 ], "title": "skip", "format": "int32", "description": "(OPTIONAL) Optional. The number of files to skip before starting to collect the result set." }, "filter": { "type": "string", "examples": [ "John Smith" ], "title": "filter", "description": "(OPTIONAL) Optional. A filter expression that filters the results listed in the response.\n Filter only currently supports a fuzzy search on display name.\n See AIP-160 for more details." }, "orderBy": { "type": "string", "examples": [ "displayName desc" ], "title": "order_by", "description": "(OPTIONAL) " } }, "title": "ListFilesRequest", "required": [ "parent" ], "additionalProperties": false }, "bndry.api.risk.entities.v1alpha.ListFilesResponse": { "type": "object", "properties": { "files": { "type": "array", "items": { "$ref": "#/components/schemas/bndry.api.datacollection.files.v1alpha.File" }, "title": "files", "description": "The list of files." }, "nextPageToken": { "type": "string", "title": "next_page_token", "description": "A token to retrieve the next page of results." }, "totalSize": { "type": "integer", "title": "total_size", "format": "int32", "description": "The total number of files." } }, "title": "ListFilesResponse", "additionalProperties": false }, "bndry.api.risk.entities.v1alpha.ListIndividualEntityRiskRatingJobsRequest": { "type": "object", "properties": { "parent": { "type": "string", "title": "parent", "description": "Required. The parent entity resource name.\n Format: entities/-", "const": "entities/-" }, "pageSize": { "type": "integer", "examples": [ 25 ], "title": "page_size", "format": "int32", "description": "(OPTIONAL) Optional. The maximum number of jobs to return. The service may return fewer than\n this value.\n If unspecified, at most 10 jobs will be returned.\n The maximum value is 100; values above 100 will be coerced to 100." }, "pageToken": { "type": "string", "examples": [ "ChAIAhABGAEiAggC" ], "title": "page_token", "description": "(OPTIONAL) Optional. A page token, received from a previous `ListIndividualEntityRiskRatingJobs` call.\n Provide this to retrieve the subsequent page.\n When paginating, all other parameters provided to `ListIndividualEntityRiskRatingJobs` must\n match the call that provided the page token." }, "skip": { "type": "integer", "examples": [ 0 ], "title": "skip", "minimum": 0, "format": "int32", "description": "(OPTIONAL) Optional. The number of jobs to skip before starting to collect the result set." } }, "title": "ListIndividualEntityRiskRatingJobsRequest", "required": [ "parent" ], "additionalProperties": false, "description": "Request message for [ListIndividualEntityRiskRatingJobs][hawk.v1alpha.IndividualEntityRiskRatingJobService.ListIndividualEntityRiskRatingJobs]." }, "bndry.api.risk.entities.v1alpha.ListIndividualEntityRiskRatingJobsResponse": { "type": "object", "properties": { "individualEntityRiskRatingJobs": { "type": "array", "items": { "$ref": "#/components/schemas/bndry.api.risk.entities.v1alpha.IndividualEntityRiskRatingJob" }, "title": "individual_entity_risk_rating_jobs", "description": "The list of risk rating jobs." }, "nextPageToken": { "type": "string", "examples": [ "cn8DAQEsQ3Vyc29yUGFnZVRva2VuW2dpdGh1Yi5jb20vZ29vZ2xlL3V1aWQuVVVJRF0B_4AAAQQBBkN1cnNvcgH_ggABBFNraXABBAABC1Nob3dEZWxldGVkAQIAAQ9SZXF1ZXN0Q2hlY2tzdW0BBgAAAAr_gQYBAv-EAAAAG_-AARABmJ6h3ll2WY12-UroKTKHA_x1wJ5cAA==" ], "title": "next_page_token", "description": "A token to retrieve the next page of results, or empty if there are no\n more results in the list." }, "totalSize": { "type": "integer", "examples": [ 47 ], "title": "total_size", "format": "int32", "description": "The total number of jobs matching the request." } }, "title": "ListIndividualEntityRiskRatingJobsResponse", "additionalProperties": false, "description": "Response message for [ListIndividualEntityRiskRatingJobs][hawk.v1alpha.IndividualEntityRiskRatingJobService.ListIndividualEntityRiskRatingJobs]." }, "bndry.api.risk.entities.v1alpha.ListIndividualEntityVerificationJobsRequest": { "type": "object", "properties": { "pageSize": { "type": "integer", "examples": [ 25 ], "title": "page_size", "format": "int32", "description": "(OPTIONAL) Optional. The maximum number of jobs to return. The service may return fewer than\n this value.\n If unspecified, at most 10 jobs will be returned.\n The maximum value is 100; values above 100 will be coerced to 100." }, "pageToken": { "type": "string", "examples": [ "ChAIAhABGAEiAggC" ], "title": "page_token", "description": "(OPTIONAL) Optional. A page token, received from a previous `ListIndividualEntityVerificationJobs` call.\n Provide this to retrieve the subsequent page.\n When paginating, all other parameters provided to `ListIndividualEntityVerificationJobs` must\n match the call that provided the page token." }, "skip": { "type": "integer", "examples": [ 0 ], "title": "skip", "minimum": 0, "format": "int32", "description": "(OPTIONAL) Optional. The number of jobs to skip before starting to collect the result set." } }, "title": "ListIndividualEntityVerificationJobsRequest", "additionalProperties": false, "description": "Request message for [ListIndividualEntityVerificationJobs][bndry.api.risk.entities.v1alpha.IndividualEntityVerificationJobService.ListIndividualEntityVerificationJobs]." }, "bndry.api.risk.entities.v1alpha.ListIndividualEntityVerificationJobsResponse": { "type": "object", "properties": { "individualEntityVerificationJobs": { "type": "array", "items": { "$ref": "#/components/schemas/bndry.api.risk.entities.v1alpha.IndividualEntityVerificationJob" }, "title": "individual_entity_verification_jobs", "description": "The list of individual entity verification jobs." }, "nextPageToken": { "type": "string", "examples": [ "ChAIAhABGAEiAggD" ], "title": "next_page_token", "description": "A token to retrieve the next page of results, or empty if there are no\n more results in the list." }, "totalSize": { "type": "integer", "examples": [ 47 ], "title": "total_size", "format": "int32", "description": "The total number of jobs matching the request." } }, "title": "ListIndividualEntityVerificationJobsResponse", "additionalProperties": false, "description": "Response message for [ListIndividualEntityVerificationJobs][bndry.api.risk.entities.v1alpha.IndividualEntityVerificationJobService.ListIndividualEntityVerificationJobs]." }, "bndry.api.risk.entities.v1alpha.ListOnboardIndividualEntityJobsRequest": { "type": "object", "properties": { "parent": { "type": "string", "title": "parent", "description": "Required. The parent entity resource name.\n Format: entities/-", "const": "entities/-" }, "pageSize": { "type": "integer", "examples": [ 25 ], "title": "page_size", "format": "int32", "description": "(OPTIONAL) Optional. The maximum number of jobs to return. The service may return fewer than\n this value.\n If unspecified, at most 10 jobs will be returned.\n The maximum value is 100; values above 100 will be coerced to 100." }, "pageToken": { "type": "string", "examples": [ "ChAIAhABGAEiAggC" ], "title": "page_token", "description": "(OPTIONAL) Optional. A page token, received from a previous `ListOnboardIndividualEntityJobs` call.\n Provide this to retrieve the subsequent page.\n When paginating, all other parameters provided to `ListOnboardIndividualEntityJobs` must\n match the call that provided the page token." }, "skip": { "type": "integer", "examples": [ 0 ], "title": "skip", "minimum": 0, "format": "int32", "description": "(OPTIONAL) Optional. The number of jobs to skip before starting to collect the result set." } }, "title": "ListOnboardIndividualEntityJobsRequest", "required": [ "parent" ], "additionalProperties": false, "description": "Request message for [ListOnboardIndividualEntityJobs][bndry.api.risk.entities.v1alpha.OnboardIndividualEntityJobService.ListOnboardIndividualEntityJobs]." }, "bndry.api.risk.entities.v1alpha.ListOnboardIndividualEntityJobsResponse": { "type": "object", "properties": { "onboardIndividualEntityJobs": { "type": "array", "items": { "$ref": "#/components/schemas/bndry.api.risk.entities.v1alpha.OnboardIndividualEntityJob" }, "title": "onboard_individual_entity_jobs", "description": "The list of onboard individual entity jobs." }, "nextPageToken": { "type": "string", "examples": [ "ChAIAhABGAEiAggD" ], "title": "next_page_token", "description": "A token to retrieve the next page of results, or empty if there are no\n more results in the list." }, "totalSize": { "type": "integer", "examples": [ 47 ], "title": "total_size", "format": "int32", "description": "The total number of jobs matching the request." } }, "title": "ListOnboardIndividualEntityJobsResponse", "additionalProperties": false, "description": "Response message for [ListOnboardIndividualEntityJobs][bndry.api.risk.entities.v1alpha.OnboardIndividualEntityJobService.ListOnboardIndividualEntityJobs]." }, "bndry.api.risk.entities.v1alpha.ListPepSanctionBusinessEntityJobsRequest": { "type": "object", "properties": { "pageSize": { "type": "integer", "examples": [ 25 ], "title": "page_size", "format": "int32", "description": "(OPTIONAL) Optional. The maximum number of jobs to return. The service may return fewer than\n this value.\n If unspecified, at most 10 jobs will be returned.\n The maximum value is 100; values above 100 will be coerced to 100." }, "pageToken": { "type": "string", "examples": [ "ChAIAhABGAEiAggC" ], "title": "page_token", "description": "(OPTIONAL) Optional. A page token, received from a previous `ListPepSanctionBusinessEntityJobs` call.\n Provide this to retrieve the subsequent page.\n When paginating, all other parameters provided to `ListPepSanctionBusinessEntityJobs` must\n match the call that provided the page token." }, "skip": { "type": "integer", "examples": [ 0 ], "title": "skip", "minimum": 0, "format": "int32", "description": "(OPTIONAL) Optional. The number of jobs to skip before starting to collect the result set." } }, "title": "ListPepSanctionBusinessEntityJobsRequest", "additionalProperties": false, "description": "Request message for [ListPepSanctionBusinessEntityJobs][bndry.api.risk.entities.v1alpha.PepSanctionBusinessEntityJobService.ListPepSanctionBusinessEntityJobs]." }, "bndry.api.risk.entities.v1alpha.ListPepSanctionBusinessEntityJobsResponse": { "type": "object", "properties": { "pepSanctionBusinessEntityJobs": { "type": "array", "items": { "$ref": "#/components/schemas/bndry.api.risk.entities.v1alpha.PepSanctionBusinessEntityJob" }, "title": "pep_sanction_business_entity_jobs", "description": "The list of PEP and sanctions screening jobs." }, "nextPageToken": { "type": "string", "examples": [ "cn8DAQEsQ3Vyc29yUGFnZVRva2VuW2dpdGh1Yi5jb20vZ29vZ2xlL3V1aWQuVVVJRF0B_4AAAQQBBkN1cnNvcgH_ggABBFNraXABBAABC1Nob3dEZWxldGVkAQIAAQ9SZXF1ZXN0Q2hlY2tzdW0BBgAAAAr_gQYBAv-EAAAAG_-AARABmJ6h3ll2WY12-UroKTKHA_x1wJ5cAA==" ], "title": "next_page_token", "description": "A token to retrieve the next page of results, or empty if there are no\n more results in the list." }, "totalSize": { "type": "integer", "examples": [ 47 ], "title": "total_size", "format": "int32", "description": "The total number of jobs matching the request." } }, "title": "ListPepSanctionBusinessEntityJobsResponse", "additionalProperties": false, "description": "Response message for [ListPepSanctionBusinessEntityJobs][bndry.api.risk.entities.v1alpha.PepSanctionBusinessEntityJobService.ListPepSanctionBusinessEntityJobs]." }, "bndry.api.risk.entities.v1alpha.ListPepSanctionIndividualEntityJobsRequest": { "type": "object", "properties": { "parent": { "type": "string", "title": "parent", "description": "Required. The parent entity resource name.\n Format: entities/-", "const": "entities/-" }, "pageSize": { "type": "integer", "examples": [ 25 ], "title": "page_size", "format": "int32", "description": "(OPTIONAL) Optional. The maximum number of jobs to return. The service may return fewer than\n this value.\n If unspecified, at most 10 jobs will be returned.\n The maximum value is 100; values above 100 will be coerced to 100." }, "pageToken": { "type": "string", "examples": [ "ChAIAhABGAEiAggC" ], "title": "page_token", "description": "(OPTIONAL) Optional. A page token, received from a previous `ListPepSanctionIndividualEntityJobs` call.\n Provide this to retrieve the subsequent page.\n When paginating, all other parameters provided to `ListPepSanctionIndividualEntityJobs` must\n match the call that provided the page token." }, "skip": { "type": "integer", "examples": [ 0 ], "title": "skip", "minimum": 0, "format": "int32", "description": "(OPTIONAL) Optional. The number of jobs to skip before starting to collect the result set." } }, "title": "ListPepSanctionIndividualEntityJobsRequest", "required": [ "parent" ], "additionalProperties": false, "description": "Request message for [ListPepSanctionIndividualEntityJobs][bndry.api.risk.entities.v1alpha.PepSanctionIndividualEntityJobService.ListPepSanctionIndividualEntityJobs]." }, "bndry.api.risk.entities.v1alpha.ListPepSanctionIndividualEntityJobsResponse": { "type": "object", "properties": { "pepSanctionIndividualEntityJobs": { "type": "array", "items": { "$ref": "#/components/schemas/bndry.api.risk.entities.v1alpha.PepSanctionIndividualEntityJob" }, "title": "pep_sanction_individual_entity_jobs", "description": "The list of PEP and sanctions screening jobs." }, "nextPageToken": { "type": "string", "examples": [ "cn8DAQEsQ3Vyc29yUGFnZVRva2VuW2dpdGh1Yi5jb20vZ29vZ2xlL3V1aWQuVVVJRF0B_4AAAQQBBkN1cnNvcgH_ggABBFNraXABBAABC1Nob3dEZWxldGVkAQIAAQ9SZXF1ZXN0Q2hlY2tzdW0BBgAAAAr_gQYBAv-EAAAAG_-AARABmJ6h3ll2WY12-UroKTKHA_x1wJ5cAA==" ], "title": "next_page_token", "description": "A token to retrieve the next page of results, or empty if there are no\n more results in the list." }, "totalSize": { "type": "integer", "examples": [ 47 ], "title": "total_size", "format": "int32", "description": "The total number of jobs matching the request." } }, "title": "ListPepSanctionIndividualEntityJobsResponse", "additionalProperties": false, "description": "Response message for [ListPepSanctionIndividualEntityJobs][bndry.api.risk.entities.v1alpha.PepSanctionIndividualEntityJobService.ListPepSanctionIndividualEntityJobs]." }, "bndry.api.risk.entities.v1alpha.Match": { "type": "object", "properties": { "providerReference": { "title": "provider_reference", "description": "Identifiers that can be used to look up the full record against the screening provider,\n or to correlate results across subsequent screenings.", "readOnly": true, "$ref": "#/components/schemas/bndry.api.risk.entities.v1alpha.ProviderReference" }, "primaryName": { "type": "string", "title": "primary_name", "description": "The individual's primary or official name as recorded by the screening provider.", "readOnly": true }, "matchedName": { "type": [ "string", "null" ], "title": "matched_name", "description": "The specific name variant (e.g., alias or spelling variation) that triggered this match.", "readOnly": true }, "score": { "type": "number", "title": "score", "format": "float", "description": "Confidence score from 0.0 (no confidence) to 1.0 (exact match).", "readOnly": true }, "datasets": { "type": "array", "items": { "$ref": "#/components/schemas/bndry.api.risk.entities.v1alpha.DatasetTag" }, "title": "datasets", "description": "Classification tags indicating which risk categories this individual appears in\n (e.g., current PEP, sanctioned, reputational risk). A single match may belong to multiple datasets.", "readOnly": true }, "name": { "title": "name", "description": "Structured name components of the matched individual.", "readOnly": true, "$ref": "#/components/schemas/bndry.api.risk.entities.v1alpha.IndividualName" }, "aliases": { "type": "array", "items": { "$ref": "#/components/schemas/bndry.api.risk.entities.v1alpha.Alias" }, "title": "aliases", "description": "Alternative names associated with this individual, including spelling variations, names in other\n scripts, maiden names, nicknames, and previous names.", "readOnly": true }, "gender": { "oneOf": [ { "$ref": "#/components/schemas/bndry.api.risk.entities.v1alpha.Gender" }, { "type": "null" } ], "title": "gender", "description": "Gender of the individual.", "readOnly": true }, "deceased": { "type": [ "boolean", "null" ], "title": "deceased", "description": "Indicates whether the provider's records show this individual as deceased.", "readOnly": true }, "birthDates": { "type": "array", "items": { "$ref": "#/components/schemas/google.type.Date" }, "title": "birth_dates", "description": "Known dates of birth for this individual. Multiple values may be present when different sources\n report different dates, or when only a birth year is known.", "readOnly": true }, "deathDates": { "type": "array", "items": { "$ref": "#/components/schemas/google.type.Date" }, "title": "death_dates", "description": "Known dates of death.", "readOnly": true }, "nationalities": { "type": "array", "items": { "type": "string", "readOnly": true }, "title": "nationalities", "description": "Country codes of known nationalities (ISO 3166-1 alpha-2).", "readOnly": true }, "addresses": { "type": "array", "items": { "$ref": "#/components/schemas/bndry.api.risk.entities.v1alpha.Address" }, "title": "addresses", "description": "Known addresses or locations associated with this individual, including current and previous\n residential, business, and place-of-birth addresses.", "readOnly": true }, "profileImages": { "type": "array", "items": { "type": "string", "readOnly": true }, "title": "profile_images", "description": "URIs to profile images of the individual, when available from the provider.", "readOnly": true }, "matchReasons": { "type": "array", "items": { "type": "string", "readOnly": true }, "title": "match_reasons", "description": "Explanations of why this record matched the query, such as name_exact, aka_exact, or\n year_of_birth, when available.", "readOnly": true }, "keywords": { "type": "array", "items": { "type": "string", "readOnly": true }, "title": "keywords", "description": "Keywords associated with this record.", "readOnly": true }, "identifiers": { "type": "array", "items": { "$ref": "#/components/schemas/bndry.api.risk.entities.v1alpha.Identifier" }, "title": "identifiers", "description": "Personal identification documents and numbers, such as passport numbers, national ID numbers,\n or tax identifiers.", "readOnly": true }, "contactEntries": { "type": "array", "items": { "$ref": "#/components/schemas/bndry.api.risk.entities.v1alpha.ContactEntry" }, "title": "contact_entries", "description": "Contact information for the individual, such as telephone numbers, email addresses, or\n fax numbers.", "readOnly": true }, "notes": { "type": "array", "items": { "type": "string", "readOnly": true }, "title": "notes", "description": "Free-text notes or annotations associated with this individual's record.", "readOnly": true }, "pep": { "title": "pep", "description": "Politically Exposed Person (PEP) details, including tier classification, current and former\n positions held, and associations with other PEPs.", "readOnly": true, "$ref": "#/components/schemas/bndry.api.risk.entities.v1alpha.PepInfo" }, "sanctions": { "title": "sanctions", "description": "Sanctions list details, including the sanctioning body, regime, measures imposed, and event\n timeline. Only present when the individual appears on one or more sanctions lists.", "readOnly": true, "$ref": "#/components/schemas/bndry.api.risk.entities.v1alpha.SanctionsInfo" }, "associates": { "type": "array", "items": { "$ref": "#/components/schemas/bndry.api.risk.entities.v1alpha.Associate" }, "title": "associates", "description": "Known associates, family members, or individuals linked to this person, along with the nature\n of their relationship.", "readOnly": true }, "evidence": { "type": "array", "items": { "$ref": "#/components/schemas/bndry.api.risk.entities.v1alpha.Evidence" }, "title": "evidence", "description": "Supporting evidence and source documentation that substantiates the risk information. Evidence\n items may be referenced by their evidence_id from PEP entries, sanction events, and other records.", "readOnly": true }, "providerUpdateTime": { "oneOf": [ { "$ref": "#/components/schemas/google.protobuf.Timestamp" }, { "type": "null" } ], "title": "provider_update_time", "description": "When the screening provider last updated this record.", "readOnly": true }, "providerCreateTime": { "oneOf": [ { "$ref": "#/components/schemas/google.protobuf.Timestamp" }, { "type": "null" } ], "title": "provider_create_time", "description": "When this record was first created in the screening provider's system.", "readOnly": true }, "adverseMedia": { "title": "adverse_media", "readOnly": true, "$ref": "#/components/schemas/bndry.api.risk.entities.v1alpha.AdverseMediaInfo" } }, "title": "Match", "additionalProperties": false, "description": "Represents an individual record from a screening provider that potentially matches the query.\n Contains identity information, risk classification, and supporting evidence." }, "bndry.api.risk.entities.v1alpha.OnboardIndividualEntityJob": { "type": "object", "properties": { "name": { "type": "string", "examples": [ "entities/-/onboardIndividualEntityJobs/mfs-onboard-job-2024-0127-kycind-743891" ], "title": "name", "description": "(IDENTIFIER) Output only. The resource name of the job.\n Format: entities/-/onboardIndividualEntityJobs/{onboard_individual_entity_job}\ncorrect_name_format // name must follow format 'entities/-/onboardIndividualEntityJobs/*'\n" }, "formDefinition": { "type": "string", "examples": [ "formDefinitions/mfs-individual-kyc-form-v2.1" ], "title": "form_definition", "description": "Required. The resource name of the form definition to use for data collection.\n Format: formDefinitions/{form_definition}\ncorrect_form_definition_format // form_definition must start with 'formDefinitions/'\n" }, "jsonataExpression": { "type": "string", "examples": [ "{\n \"legal_name\": {\n \"given_name\": $$.form_data.personal_info.first_name,\n \"family_name\": $$.form_data.personal_info.last_name\n },\n \"date_of_birth\": $$.form_data.personal_info.dob,\n \"addresses\": [{\n \"type\": \"RESIDENTIAL\",\n \"street_address\": $$.form_data.address.street,\n \"city\": $$.form_data.address.city,\n \"postal_code\": $$.form_data.address.zip\n }],\n \"tax_identification\": {\n \"tax_id_number\": $$.form_data.tax_info.ssn,\n \"tax_id_type\": \"US_SSN\"\n }\n}" ], "title": "jsonata_expression", "minLength": 1, "format": "byte", "description": "Required. JSONata expression to transform form response into IndividualEntity. This must be base64-encoded when sent in JSON requests." }, "webhookUri": { "type": "string", "examples": [ "https://api.example.com/webhooks/onboarding/individual/entity-job-status" ], "title": "webhook_uri", "maxLength": 2048, "format": "uri", "description": "Required. Webhook target URI for notifications." }, "createTime": { "title": "create_time", "description": "Output only. The timestamp when the job was created.", "readOnly": true, "$ref": "#/components/schemas/google.protobuf.Timestamp" }, "updateTime": { "title": "update_time", "description": "Output only. The timestamp when the job was most recently updated.", "readOnly": true, "$ref": "#/components/schemas/google.protobuf.Timestamp" } }, "title": "OnboardIndividualEntityJob", "required": [ "formDefinition", "jsonataExpression", "webhookUri" ], "additionalProperties": false, "description": "Represents a job for onboarding individual entities through data capture,\n entity creation, and verification workflows." }, "bndry.api.risk.entities.v1alpha.PepAssociation": { "type": "object", "properties": { "name": { "type": "string", "title": "name", "description": "The name of the associated PEP individual.", "readOnly": true }, "resourceId": { "type": [ "string", "null" ], "title": "resource_id", "description": "The provider's resource identifier for the associated PEP.", "readOnly": true }, "resourceUri": { "type": [ "string", "null" ], "title": "resource_uri", "description": "A URI for retrieving the associated PEP's full profile from the provider.", "readOnly": true }, "evidenceIds": { "type": "array", "items": { "type": "string", "readOnly": true }, "title": "evidence_ids", "description": "References to supporting evidence documents. Each ID corresponds to an evidence_id in the\n evidence list on the parent Match.", "readOnly": true } }, "title": "PepAssociation", "additionalProperties": false, "description": "Represents a PEP-by-association relationship, indicating that the screened individual is linked\n to a Politically Exposed Person." }, "bndry.api.risk.entities.v1alpha.PepEntry": { "type": "object", "properties": { "status": { "title": "status", "description": "Whether this position is currently held, formerly held, or of unknown status.", "readOnly": true, "$ref": "#/components/schemas/bndry.api.risk.entities.v1alpha.PepEntryStatus" }, "country": { "type": [ "string", "null" ], "title": "country", "description": "Country where the position is held (ISO 3166-1 alpha-2).", "readOnly": true }, "segment": { "type": [ "string", "null" ], "title": "segment", "description": "Government segment (e.g., \"Executive\", \"Legislative\", \"Judiciary\").", "readOnly": true }, "position": { "type": [ "string", "null" ], "title": "position", "description": "The specific political position or title held (e.g., \"Prime Minister\", \"Member of Parliament\").", "readOnly": true }, "startDate": { "oneOf": [ { "$ref": "#/components/schemas/google.type.Date" }, { "type": "null" } ], "title": "start_date", "description": "Start date of the position.", "readOnly": true }, "endDate": { "oneOf": [ { "$ref": "#/components/schemas/google.type.Date" }, { "type": "null" } ], "title": "end_date", "description": "End date of the position, if no longer held.", "readOnly": true }, "evidenceIds": { "type": "array", "items": { "type": "string", "readOnly": true }, "title": "evidence_ids", "description": "References to supporting evidence documents. Each ID corresponds to an evidence_id in the\n evidence list on the parent Match.", "readOnly": true } }, "title": "PepEntry", "additionalProperties": false, "description": "Represents a single political position held by the individual." }, "bndry.api.risk.entities.v1alpha.PepEntryStatus": { "type": "string", "title": "PepEntryStatus", "enum": [ "PEP_ENTRY_STATUS_UNSPECIFIED", "PEP_ENTRY_STATUS_CURRENT", "PEP_ENTRY_STATUS_FORMER", "PEP_ENTRY_STATUS_UNKNOWN" ], "description": "Status of a PEP entry." }, "bndry.api.risk.entities.v1alpha.PepInfo": { "type": "object", "properties": { "tiers": { "type": "array", "items": { "$ref": "#/components/schemas/bndry.api.risk.entities.v1alpha.PepTier" }, "title": "tiers", "description": "The PEP tier classifications assigned to this individual.", "readOnly": true }, "entries": { "type": "array", "items": { "$ref": "#/components/schemas/bndry.api.risk.entities.v1alpha.PepEntry" }, "title": "entries", "description": "Individual political positions held by this person.", "readOnly": true }, "associations": { "type": "array", "items": { "$ref": "#/components/schemas/bndry.api.risk.entities.v1alpha.PepAssociation" }, "title": "associations", "description": "PEP-by-association entries, indicating that this individual is linked to a Politically Exposed\n Person (e.g., a family member or close business associate of a PEP).", "readOnly": true }, "politicalParties": { "type": "array", "items": { "type": "string", "readOnly": true }, "title": "political_parties", "description": "Political party affiliations.", "readOnly": true }, "politicalRegions": { "type": "array", "items": { "type": "string", "readOnly": true }, "title": "political_regions", "description": "Political regions or constituencies.", "readOnly": true } }, "title": "PepInfo", "additionalProperties": false, "description": "Contains Politically Exposed Person (PEP) details for the individual, including their tier\n classification, current and former political positions, party affiliations, and any\n PEP-by-association relationships." }, "bndry.api.risk.entities.v1alpha.PepSanctionBusinessEntityJob": { "type": "object", "properties": { "name": { "type": "string", "examples": [ "pepSanctionBusinessEntityJobs/pep-sanction-screen-2024-0127-743891" ], "title": "name", "description": "(IDENTIFIER) Output only. The resource name of the job.\n Format: pepSanctionBusinessEntityJobs/{pep_sanction_business_entity_job}\ncorrect_name_format // name must follow format 'pepSanctionBusinessEntityJobs/*'\n" }, "createTime": { "title": "create_time", "description": "Output only. The timestamp when the job was created.", "readOnly": true, "$ref": "#/components/schemas/google.protobuf.Timestamp" }, "updateTime": { "title": "update_time", "description": "Output only. The timestamp when the job was most recently updated.", "readOnly": true, "$ref": "#/components/schemas/google.protobuf.Timestamp" } }, "title": "PepSanctionBusinessEntityJob", "additionalProperties": false, "description": "Represents a job for performing PEP and sanctions screening on business entities." }, "bndry.api.risk.entities.v1alpha.PepSanctionIndividualEntityJob": { "type": "object", "properties": { "name": { "type": "string", "examples": [ "entities/-/pepSanctionIndividualEntityJobs/pep-sanction-screen-2024-0127-743891" ], "title": "name", "description": "(IDENTIFIER) Output only. The resource name of the job.\n Format: entities/-/pepSanctionIndividualEntityJobs/{pep_sanction_individual_entity_job}\ncorrect_name_format // name must follow format 'entities/-/pepSanctionIndividualEntityJobs/*'\n" }, "createTime": { "title": "create_time", "description": "Output only. The timestamp when the job was created.", "readOnly": true, "$ref": "#/components/schemas/google.protobuf.Timestamp" }, "updateTime": { "title": "update_time", "description": "Output only. The timestamp when the job was most recently updated.", "readOnly": true, "$ref": "#/components/schemas/google.protobuf.Timestamp" } }, "title": "PepSanctionIndividualEntityJob", "additionalProperties": false, "description": "Represents a job for performing PEP and sanctions screening on individual entities." }, "bndry.api.risk.entities.v1alpha.PepSanctionResult": { "type": "object", "properties": { "provider": { "title": "provider", "description": "Identifies which screening provider (e.g., RapidID, KYC6) produced these results.", "readOnly": true, "$ref": "#/components/schemas/bndry.api.risk.entities.v1alpha.ScreeningProvider" }, "query": { "title": "query", "description": "Contains the search parameters that were submitted, useful for auditing what was screened.", "readOnly": true, "$ref": "#/components/schemas/bndry.api.risk.entities.v1alpha.QueryContext" }, "matches": { "type": "array", "items": { "$ref": "#/components/schemas/bndry.api.risk.entities.v1alpha.Match" }, "title": "matches", "description": "Ordered by relevance score (highest first). May be empty if no matches were found.", "readOnly": true } }, "title": "PepSanctionResult", "additionalProperties": false, "description": "The output of a PEP and sanctions screening check, containing the original query\n parameters and any matches found." }, "bndry.api.risk.entities.v1alpha.PepTier": { "type": "string", "title": "PepTier", "enum": [ "PEP_TIER_UNSPECIFIED", "PEP_TIER_1", "PEP_TIER_2", "PEP_TIER_3", "PEP_TIER_4", "PEP_TIER_BY_ASSOCIATION" ], "description": "Classification of a Politically Exposed Person's tier level, indicating the seniority and scope of their political role." }, "bndry.api.risk.entities.v1alpha.ProfileOfInterestEntry": { "type": "object", "properties": { "category": { "type": [ "string", "null" ], "title": "category", "description": "The category of interest.", "readOnly": true }, "positions": { "type": "array", "items": { "$ref": "#/components/schemas/bndry.api.risk.entities.v1alpha.ProfileOfInterestPosition" }, "title": "positions", "description": "Positions or roles held.", "readOnly": true }, "evidenceIds": { "type": "array", "items": { "type": "string", "readOnly": true }, "title": "evidence_ids", "description": "References to supporting evidence documents.", "readOnly": true } }, "title": "ProfileOfInterestEntry", "additionalProperties": false, "description": "A profile of interest entry, indicating positions or roles held by the entity." }, "bndry.api.risk.entities.v1alpha.ProfileOfInterestPosition": { "type": "object", "properties": { "position": { "type": "string", "title": "position", "description": "The title or role.", "readOnly": true }, "segment": { "type": [ "string", "null" ], "title": "segment", "description": "Government segment (e.g., \"Executive\", \"Legislative\").", "readOnly": true }, "countryCode": { "type": [ "string", "null" ], "title": "country_code", "description": "Country where the position is held (ISO 3166-1 alpha-2).", "readOnly": true }, "startDate": { "oneOf": [ { "$ref": "#/components/schemas/google.type.Date" }, { "type": "null" } ], "title": "start_date", "description": "Start date of the position.", "readOnly": true }, "endDate": { "oneOf": [ { "$ref": "#/components/schemas/google.type.Date" }, { "type": "null" } ], "title": "end_date", "description": "End date of the position.", "readOnly": true } }, "title": "ProfileOfInterestPosition", "additionalProperties": false, "description": "A position or role within a profile of interest entry." }, "bndry.api.risk.entities.v1alpha.ProviderConfig": { "type": "object", "properties": { "truuthVerificationConfig": { "title": "truuth_verification_config", "description": "(OPTIONAL) ", "$ref": "#/components/schemas/bndry.api.risk.truuth.v1alpha.TruuthVerificationConfig" } }, "title": "ProviderConfig", "additionalProperties": false }, "bndry.api.risk.entities.v1alpha.ProviderReference": { "type": "object", "properties": { "recordId": { "type": "string", "title": "record_id", "description": "The unique identifier for this record in the provider's system.", "readOnly": true }, "resourceUri": { "type": [ "string", "null" ], "title": "resource_uri", "description": "URI to retrieve the full profile from the provider.", "readOnly": true }, "version": { "type": [ "integer", "string", "null" ], "title": "version", "format": "int64", "description": "A version number that changes when the provider updates this record.", "readOnly": true } }, "title": "ProviderReference", "additionalProperties": false, "description": "Reference identifiers for a matched record in the provider's system." }, "bndry.api.risk.entities.v1alpha.QueryContext": { "type": "object", "properties": { "name": { "oneOf": [ { "$ref": "#/components/schemas/bndry.api.risk.entities.v1alpha.IndividualName" }, { "type": "null" } ], "title": "name", "description": "(OPTIONAL) The name that was searched." }, "birthDate": { "oneOf": [ { "$ref": "#/components/schemas/google.type.Date" }, { "type": "null" } ], "title": "birth_date", "description": "(OPTIONAL) Date of birth used to narrow screening results." }, "countries": { "type": "array", "items": { "type": "string", "description": "(OPTIONAL) " }, "title": "countries", "description": "(OPTIONAL) Country codes used to filter results (ISO 3166-1 alpha-2)." }, "fuzziness": { "type": [ "number", "null" ], "title": "fuzziness", "format": "float", "description": "(OPTIONAL) Controls how loosely names are matched. A value of 0.0 requires an exact match; 1.0 allows\n maximum fuzziness." }, "exactMatch": { "type": [ "boolean", "null" ], "title": "exact_match", "description": "(OPTIONAL) When true, only exact name matches are returned. Overrides fuzziness." } }, "title": "QueryContext", "additionalProperties": false, "description": "The original query parameters submitted for screening." }, "bndry.api.risk.entities.v1alpha.RegulatoryEnforcementCategory": { "type": "string", "title": "RegulatoryEnforcementCategory", "enum": [ "REGULATORY_ENFORCEMENT_CATEGORY_UNSPECIFIED", "REGULATORY_ENFORCEMENT_CATEGORY_FINANCIAL_REGULATOR", "REGULATORY_ENFORCEMENT_CATEGORY_LAW_ENFORCEMENT" ], "description": "Category of regulatory enforcement action." }, "bndry.api.risk.entities.v1alpha.RegulatoryEnforcementEntry": { "type": "object", "properties": { "category": { "title": "category", "description": "The category of regulatory action (e.g., financial regulator, law enforcement).", "readOnly": true, "$ref": "#/components/schemas/bndry.api.risk.entities.v1alpha.RegulatoryEnforcementCategory" }, "subcategory": { "type": [ "string", "null" ], "title": "subcategory", "description": "Subcategory providing further detail on the action.", "readOnly": true }, "events": { "type": "array", "items": { "$ref": "#/components/schemas/bndry.api.risk.entities.v1alpha.RegulatoryEnforcementEvent" }, "title": "events", "description": "Timeline of events related to this enforcement action.", "readOnly": true } }, "title": "RegulatoryEnforcementEntry", "additionalProperties": false, "description": "A regulatory enforcement action taken against the entity." }, "bndry.api.risk.entities.v1alpha.RegulatoryEnforcementEvent": { "type": "object", "properties": { "type": { "type": "string", "title": "type", "description": "The type of event (e.g., \"investigation\", \"fine\", \"settlement\").", "readOnly": true }, "currencyCode": { "type": [ "string", "null" ], "title": "currency_code", "description": "The currency code for any monetary amount (ISO 4217).", "readOnly": true }, "amount": { "type": [ "integer", "null" ], "title": "amount", "format": "int32", "description": "The monetary amount associated with this event (e.g., fine amount).", "readOnly": true }, "date": { "oneOf": [ { "$ref": "#/components/schemas/google.type.Date" }, { "type": "null" } ], "title": "date", "description": "Date of the event.", "readOnly": true }, "evidenceIds": { "type": "array", "items": { "type": "string", "readOnly": true }, "title": "evidence_ids", "description": "References to supporting evidence documents.", "readOnly": true } }, "title": "RegulatoryEnforcementEvent", "additionalProperties": false, "description": "An event in the lifecycle of a regulatory enforcement action." }, "bndry.api.risk.entities.v1alpha.RelationshipType": { "type": "string", "title": "RelationshipType", "enum": [ "RELATIONSHIP_TYPE_UNSPECIFIED", "DIRECTOR_OF", "INVERSE_DIRECTOR_OF", "SHAREHOLDER_OF", "INVERSE_SHAREHOLDER_OF", "BENEFICIAL_OWNER_OF", "INVERSE_BENEFICIAL_OWNER_OF", "OWNER_OF", "INVERSE_OWNER_OF", "UBO_OF", "INVERSE_UBO_OF", "EMPLOYEE_OF", "INVERSE_EMPLOYEE_OF", "SUPPLIER_OF", "INVERSE_SUPPLIER_OF", "AUTHORIZED_REPRESENTATIVE_OF", "INVERSE_AUTHORIZED_REPRESENTATIVE_OF", "CUSTOMER_OF", "INVERSE_CUSTOMER_OF", "TRUSTEE_OF", "INVERSE_TRUSTEE_OF", "SETTLOR_OF", "INVERSE_SETTLOR_OF", "BENEFICIARIES_OF", "INVERSE_BENEFICIARIES_OF", "PROTECTORS_OF", "INVERSE_PROTECTORS_OF", "TRUST_ADMINISTRATOR_OF", "INVERSE_TRUST_ADMINISTRATOR_OF", "FAMILY", "FRIEND" ] }, "bndry.api.risk.entities.v1alpha.RelationshipView": { "type": "string", "title": "RelationshipView", "enum": [ "RELATIONSHIP_VIEW_UNSPECIFIED", "RELATIONSHIP_VIEW_BASIC", "RELATIONSHIP_VIEW_TARGET_PARTIAL", "RELATIONSHIP_VIEW_FULL" ] }, "bndry.api.risk.entities.v1alpha.RemoveEntityRelationshipRequest": { "type": "object", "properties": { "name": { "type": "string", "examples": [ "entities/example-financial-services" ], "title": "name", "description": "correct_name_format // name must start with 'entities/'\n" }, "targetEntity": { "type": "string", "examples": [ "entities/john-smith-001" ], "title": "target_entity", "description": "correct_name_format // name must start with 'entities/'\n" }, "relationshipType": { "title": "relationship_type", "$ref": "#/components/schemas/bndry.api.risk.entities.v1alpha.RelationshipType" } }, "title": "RemoveEntityRelationshipRequest", "required": [ "name", "targetEntity", "relationshipType" ], "additionalProperties": false }, "bndry.api.risk.entities.v1alpha.RemoveTagRequest": { "type": "object", "properties": { "name": { "type": "string", "examples": [ "entities/john-smith-001" ], "title": "name", "description": "Required. The resource name of the entity.\n Format: entities/{entity}" }, "tag": { "title": "tag", "description": "Required. The tag to remove from the entity.", "$ref": "#/components/schemas/bndry.api.risk.entities.v1alpha.Tag" } }, "title": "RemoveTagRequest", "required": [ "name", "tag" ], "additionalProperties": false, "description": "Request message for [bndry.api.risk.v1alpha.EntityService.RemoveTag]." }, "bndry.api.risk.entities.v1alpha.ReputationalRiskEntry": { "type": "object", "properties": { "category": { "type": [ "string", "null" ], "title": "category", "description": "The category of reputational risk.", "readOnly": true }, "subcategory": { "type": [ "string", "null" ], "title": "subcategory", "description": "Subcategory providing further detail.", "readOnly": true }, "events": { "type": "array", "items": { "$ref": "#/components/schemas/bndry.api.risk.entities.v1alpha.ReputationalRiskEvent" }, "title": "events", "description": "Timeline of events related to this reputational risk exposure.", "readOnly": true } }, "title": "ReputationalRiskEntry", "additionalProperties": false, "description": "A reputational risk exposure entry (adverse media)." }, "bndry.api.risk.entities.v1alpha.ReputationalRiskEvent": { "type": "object", "properties": { "type": { "type": "string", "title": "type", "description": "The type of event.", "readOnly": true }, "date": { "oneOf": [ { "$ref": "#/components/schemas/google.type.Date" }, { "type": "null" } ], "title": "date", "description": "Date of the event.", "readOnly": true }, "evidenceIds": { "type": "array", "items": { "type": "string", "readOnly": true }, "title": "evidence_ids", "description": "References to supporting evidence documents.", "readOnly": true } }, "title": "ReputationalRiskEvent", "additionalProperties": false, "description": "An event in the lifecycle of a reputational risk exposure." }, "bndry.api.risk.entities.v1alpha.RunIndividualEntityIDVerificationJobMetadata": { "type": "object", "title": "RunIndividualEntityIDVerificationJobMetadata", "additionalProperties": false, "description": "Metadata message for [RunIndividualEntityIDVerificationJob][bndry.api.risk.entities.v1alpha.IndividualEntityIDVerificationJobService.RunIndividualEntityIDVerificationJob] long-running operation.\n Empty for now - can be expanded with screening progress information in the future" }, "bndry.api.risk.entities.v1alpha.RunIndividualEntityIDVerificationJobResponse": { "type": "object", "title": "RunIndividualEntityIDVerificationJobResponse", "additionalProperties": false, "description": "Response message for [RunIndividualEntityIDVerificationJob][bndry.api.risk.entities.v1alpha.IndividualEntityIDVerificationJobService.RunIndividualEntityIDVerificationJob]." }, "bndry.api.risk.entities.v1alpha.RunIndividualEntityRiskRatingJobMetadata": { "type": "object", "title": "RunIndividualEntityRiskRatingJobMetadata", "additionalProperties": false, "description": "Metadata message for [RunIndividualEntityRiskRatingJob][hawk.v1alpha.IndividualEntityRiskRatingJobService.RunIndividualEntityRiskRatingJob] long-running operation.\n Empty for now - can be expanded with screening progress information in the future" }, "bndry.api.risk.entities.v1alpha.RunIndividualEntityRiskRatingJobRequest": { "type": "object", "properties": { "name": { "type": "string", "examples": [ "entities/john-smith-001/individualEntityRiskRatingJobs/risk-rating-screen-001" ], "title": "name", "description": "Required. The resource name of the job to run.\n Format: entities/{entity}/individualEntityRiskRatingJobs/{individual_entity_risk_rating_job}\n The entity resource name will be extracted from the path.\ncorrect_name_format // name must follow format 'entities/*/individualEntityRiskRatingJobs/*'\n" } }, "title": "RunIndividualEntityRiskRatingJobRequest", "required": [ "name" ], "additionalProperties": false, "description": "Request message for [RunIndividualEntityRiskRatingJob][hawk.v1alpha.IndividualEntityRiskRatingJobService.RunIndividualEntityRiskRatingJob]." }, "bndry.api.risk.entities.v1alpha.RunIndividualEntityRiskRatingJobResponse": { "type": "object", "properties": { "entity": { "type": "string", "examples": [ "entities/john-smith-001" ], "title": "entity", "description": "The resource name of the entity that was screened.\n Format: entities/{entity}", "readOnly": true } }, "title": "RunIndividualEntityRiskRatingJobResponse", "additionalProperties": false, "description": "Response message for [RunIndividualEntityRiskRatingJob][hawk.v1alpha.IndividualEntityRiskRatingJobService.RunIndividualEntityRiskRatingJob]." }, "bndry.api.risk.entities.v1alpha.RunIndividualEntityVerificationJobMetadata": { "type": "object", "properties": { "initialRedirectUri": { "type": "string", "examples": [ "https://forms.bndry.app/verification/start?token=abc123" ], "title": "initial_redirect_uri", "format": "uri", "description": "The initial redirect URI where the user should be sent to begin verification.", "readOnly": true }, "verification": { "title": "verification", "description": "Metadata for verification workflow.", "readOnly": true, "$ref": "#/components/schemas/bndry.api.risk.entities.v1alpha.VerificationMetadata" }, "finalRedirectUri": { "type": "string", "examples": [ "https://app.example.com/verification/complete" ], "title": "final_redirect_uri", "format": "uri", "description": "The final redirect URI where the user should be sent after verification is complete.", "readOnly": true }, "entityResourceName": { "type": "string", "examples": [ "entities/john-smith-001" ], "title": "entity_resource_name", "description": "The resource name of the entity that was verified.\n Format: entities/{entity}", "readOnly": true }, "webhookUri": { "type": "string", "examples": [ "https://hooks.example.com/verification" ], "title": "webhook_uri", "format": "uri", "readOnly": true } }, "title": "RunIndividualEntityVerificationJobMetadata", "additionalProperties": false, "description": "Metadata message for [RunIndividualEntityVerificationJob][bndry.api.risk.entities.v1alpha.IndividualEntityVerificationJobService.RunIndividualEntityVerificationJob] long-running operation." }, "bndry.api.risk.entities.v1alpha.RunIndividualEntityVerificationJobRequest": { "type": "object", "properties": { "name": { "type": "string", "examples": [ "individualEntityVerificationJobs/verification-001" ], "title": "name", "description": "Required. The resource name of the job to run.\n Format: individualEntityVerificationJobs/{individual_entity_verification_job}\ncorrect_name_format // name must follow format 'individualEntityVerificationJobs/*'\n" }, "entityResourceName": { "type": "string", "examples": [ "entities/john-smith-001" ], "title": "entity_resource_name", "description": "Required. The resource name of the entity to verify.\n Format: entities/{entity}\ncorrect_entity_format // entity must follow format 'entities/*'\n" }, "redirectUri": { "type": "string", "examples": [ "https://app.example.com/verification/complete" ], "title": "redirect_uri", "format": "uri", "description": "Required. The final redirect URI where the user should be sent after verification is complete." } }, "title": "RunIndividualEntityVerificationJobRequest", "required": [ "name", "entityResourceName", "redirectUri" ], "additionalProperties": false, "description": "Request message for [RunIndividualEntityVerificationJob][bndry.api.risk.entities.v1alpha.IndividualEntityVerificationJobService.RunIndividualEntityVerificationJob]." }, "bndry.api.risk.entities.v1alpha.RunIndividualEntityVerificationJobResponse": { "type": "object", "properties": { "entityResourceName": { "type": "string", "examples": [ "entities/john-smith-001" ], "title": "entity_resource_name", "description": "The resource name of the entity that was verified.\n Format: entities/{entity}", "readOnly": true }, "redirectUri": { "type": "string", "examples": [ "https://app.example.com/verification/complete" ], "title": "redirect_uri", "format": "uri", "description": "Required. The final redirect URI where the user should be sent after verification is complete.", "readOnly": true } }, "title": "RunIndividualEntityVerificationJobResponse", "additionalProperties": false, "description": "Response message for [RunIndividualEntityVerificationJob][bndry.api.risk.entities.v1alpha.IndividualEntityVerificationJobService.RunIndividualEntityVerificationJob]." }, "bndry.api.risk.entities.v1alpha.RunKybProfileGenerationJobMetadata": { "type": "object", "title": "RunKybProfileGenerationJobMetadata", "additionalProperties": false, "description": "Metadata message for [RunKybProfileGenerationJob][bndry.api.risk.entities.v1alpha.KybProfileGenerationJobService.RunKybProfileGenerationJob] long-running operation.\n Empty for now - can be expanded with screening progress information in the future" }, "bndry.api.risk.entities.v1alpha.RunKybProfileGenerationJobResponse": { "type": "object", "title": "RunKybProfileGenerationJobResponse", "additionalProperties": false, "description": "Response message for [RunKybProfileGenerationJob][bndry.api.risk.entities.v1alpha.KybProfileGenerationJobService.RunKybProfileGenerationJob]." }, "bndry.api.risk.entities.v1alpha.RunOnboardIndividualEntityJobMetadata": { "type": "object", "properties": { "redirectUri": { "type": "string", "examples": [ "https://forms.bndry.app/kyc/form/kyc-individual-mfs-001" ], "title": "redirect_uri", "format": "uri", "description": "The initial redirect URI where the user should be sent to begin onboarding.", "readOnly": true }, "form": { "type": "string", "examples": [ "forms/kyc-entity-capture-form" ], "title": "form", "readOnly": true }, "verification": { "title": "verification", "description": "Metadata for verification workflow.", "readOnly": true, "$ref": "#/components/schemas/bndry.api.risk.entities.v1alpha.VerificationMetadata" }, "finalRedirectUri": { "type": "string", "examples": [ "https://bndry.app" ], "title": "final_redirect_uri", "format": "uri", "description": "the final redirect URI where the user should be sent after onboarding is complete.", "readOnly": true }, "entityResourceName": { "type": "string", "examples": [ "entities/john-smith-01" ], "title": "entity_resource_name", "readOnly": true }, "webhookUri": { "type": "string", "examples": [ "https://webhook.bndry.app" ], "title": "webhook_uri", "format": "uri", "readOnly": true } }, "title": "RunOnboardIndividualEntityJobMetadata", "additionalProperties": false, "description": "Metadata message for [RunOnboardIndividualEntityJob][bndry.api.risk.entities.v1alpha.OnboardIndividualEntityJobService.RunOnboardIndividualEntityJob] long-running operation." }, "bndry.api.risk.entities.v1alpha.RunOnboardIndividualEntityJobRequest": { "type": "object", "properties": { "name": { "type": "string", "examples": [ "entities/-/onboardIndividualEntityJobs/kyc-individual-mfs-001" ], "title": "name", "description": "Required. The resource name of the job to run.\n Format: entities/-/onboardIndividualEntityJobs/{onboard_individual_entity_job}\ncorrect_name_format // name must follow format 'entities/-/onboardIndividualEntityJobs/*'\n" }, "redirectUri": { "type": "string", "examples": [ "https://app.example.com/kyc/complete" ], "title": "redirect_uri", "format": "uri", "description": "The final redirect URI where the user should be sent after onboarding is complete." }, "entityAnnotations": { "type": "object", "title": "entity_annotations", "additionalProperties": { "type": "string", "title": "value" }, "description": "(OPTIONAL) Optional. Arbitrary annotations to be applied to the entity being created." } }, "title": "RunOnboardIndividualEntityJobRequest", "required": [ "name", "redirectUri" ], "additionalProperties": false, "description": "Request message for [RunOnboardIndividualEntityJob][bndry.api.risk.entities.v1alpha.OnboardIndividualEntityJobService.RunOnboardIndividualEntityJob]." }, "bndry.api.risk.entities.v1alpha.RunOnboardIndividualEntityJobRequest.EntityAnnotationsEntry": { "type": "object", "properties": { "key": { "type": "string", "title": "key" }, "value": { "type": "string", "title": "value" } }, "title": "EntityAnnotationsEntry", "additionalProperties": false }, "bndry.api.risk.entities.v1alpha.RunOnboardIndividualEntityJobResponse": { "type": "object", "properties": { "entityResourceName": { "type": "string", "examples": [ "entities/john-smith-001" ], "title": "entity_resource_name", "description": "The resource name of the entity that was created during onboarding.\n Format: entities/{entity}", "readOnly": true }, "redirectUri": { "type": "string", "examples": [ "https://app.example.com/kyc/complete" ], "title": "redirect_uri", "format": "uri", "description": "The final redirect URI where the user should be sent after onboarding is complete.", "readOnly": true } }, "title": "RunOnboardIndividualEntityJobResponse", "additionalProperties": false, "description": "Response message for [RunOnboardIndividualEntityJob][bndry.api.risk.entities.v1alpha.OnboardIndividualEntityJobService.RunOnboardIndividualEntityJob]." }, "bndry.api.risk.entities.v1alpha.RunPepSanctionBusinessEntityJobMetadata": { "type": "object", "properties": { "executionInfo": { "title": "execution_info", "description": "Shared execution information for this job run.", "$ref": "#/components/schemas/bndry.api.risk.entities.v1alpha.ExecutionInfo" } }, "title": "RunPepSanctionBusinessEntityJobMetadata", "additionalProperties": false, "description": "Metadata message for [RunPepSanctionBusinessEntityJob][bndry.api.risk.entities.v1alpha.PepSanctionBusinessEntityJobService.RunPepSanctionBusinessEntityJob] long-running operation." }, "bndry.api.risk.entities.v1alpha.RunPepSanctionBusinessEntityJobRequest": { "type": "object", "properties": { "name": { "type": "string", "examples": [ "pepSanctionBusinessEntityJobs/pep-sanction-screen-001" ], "title": "name", "description": "Required. The resource name of the job to run.\n Format: pepSanctionBusinessEntityJobs/{pep_sanction_business_entity_job}\ncorrect_name_format // name must follow format 'pepSanctionBusinessEntityJobs/*'\n" }, "entity": { "type": "string", "examples": [ "entities/acme-corp-001" ], "title": "entity", "description": "Required. The resource name of the entity to screen.\n Format: entities/{entity}" } }, "title": "RunPepSanctionBusinessEntityJobRequest", "required": [ "name", "entity" ], "additionalProperties": false, "description": "Request message for [RunPepSanctionBusinessEntityJob][bndry.api.risk.entities.v1alpha.PepSanctionBusinessEntityJobService.RunPepSanctionBusinessEntityJob]." }, "bndry.api.risk.entities.v1alpha.RunPepSanctionBusinessEntityJobResponse": { "type": "object", "properties": { "entity": { "type": "string", "examples": [ "entities/acme-corp-001" ], "title": "entity", "description": "The resource name of the entity that was screened.\n Format: entities/{entity}", "readOnly": true }, "result": { "title": "result", "description": "The screening result from the PEP and sanctions check.", "readOnly": true, "$ref": "#/components/schemas/bndry.api.risk.entities.v1alpha.BusinessPepSanctionResult" } }, "title": "RunPepSanctionBusinessEntityJobResponse", "additionalProperties": false, "description": "Response message for [RunPepSanctionBusinessEntityJob][bndry.api.risk.entities.v1alpha.PepSanctionBusinessEntityJobService.RunPepSanctionBusinessEntityJob]." }, "bndry.api.risk.entities.v1alpha.RunPepSanctionIndividualEntityJobMetadata": { "type": "object", "properties": { "executionInfo": { "title": "execution_info", "description": "Shared execution information for this job run.", "$ref": "#/components/schemas/bndry.api.risk.entities.v1alpha.ExecutionInfo" } }, "title": "RunPepSanctionIndividualEntityJobMetadata", "additionalProperties": false, "description": "Metadata message for [RunPepSanctionIndividualEntityJob][bndry.api.risk.entities.v1alpha.PepSanctionIndividualEntityJobService.RunPepSanctionIndividualEntityJob] long-running operation." }, "bndry.api.risk.entities.v1alpha.RunPepSanctionIndividualEntityJobRequest": { "type": "object", "properties": { "name": { "type": "string", "examples": [ "entities/john-smith-001/pepSanctionIndividualEntityJobs/pep-sanction-screen-001" ], "title": "name", "description": "Required. The resource name of the job to run.\n Format: entities/{entity}/pepSanctionIndividualEntityJobs/{pep_sanction_individual_entity_job}\n The entity resource name will be extracted from the path.\ncorrect_name_format // name must follow format 'entities/*/pepSanctionIndividualEntityJobs/*'\n" } }, "title": "RunPepSanctionIndividualEntityJobRequest", "required": [ "name" ], "additionalProperties": false, "description": "Request message for [RunPepSanctionIndividualEntityJob][bndry.api.risk.entities.v1alpha.PepSanctionIndividualEntityJobService.RunPepSanctionIndividualEntityJob]." }, "bndry.api.risk.entities.v1alpha.RunPepSanctionIndividualEntityJobResponse": { "type": "object", "properties": { "entity": { "type": "string", "examples": [ "entities/john-smith-001" ], "title": "entity", "description": "The resource name of the entity that was screened.\n Format: entities/{entity}", "readOnly": true }, "result": { "title": "result", "description": "The screening result from the PEP and sanctions check.", "readOnly": true, "$ref": "#/components/schemas/bndry.api.risk.entities.v1alpha.PepSanctionResult" } }, "title": "RunPepSanctionIndividualEntityJobResponse", "additionalProperties": false, "description": "Response message for [RunPepSanctionIndividualEntityJob][bndry.api.risk.entities.v1alpha.PepSanctionIndividualEntityJobService.RunPepSanctionIndividualEntityJob]." }, "bndry.api.risk.entities.v1alpha.SanctionEntry": { "type": "object", "properties": { "status": { "title": "status", "description": "Whether this sanction is currently active, formerly active, or of unknown status.", "readOnly": true, "$ref": "#/components/schemas/bndry.api.risk.entities.v1alpha.SanctionEntryStatus" }, "sanctionId": { "type": [ "string", "null" ], "title": "sanction_id", "description": "The unique identifier assigned to this sanction by the sanctioning body.", "readOnly": true }, "measures": { "type": "array", "items": { "type": "string", "readOnly": true }, "title": "measures", "description": "The specific measures or restrictions imposed, such as \"Travel Ban\", \"Asset Freeze\", or\n \"Arms Embargo\".", "readOnly": true }, "regime": { "title": "regime", "description": "Details about the sanctioning regime.", "readOnly": true, "$ref": "#/components/schemas/bndry.api.risk.entities.v1alpha.SanctionRegime" }, "events": { "type": "array", "items": { "$ref": "#/components/schemas/bndry.api.risk.entities.v1alpha.SanctionEvent" }, "title": "events", "description": "A timeline of events related to this sanction, such as when it was added,\n amended, or removed.", "readOnly": true } }, "title": "SanctionEntry", "additionalProperties": false, "description": "Represents a single sanction listing for the individual by a specific sanctioning body." }, "bndry.api.risk.entities.v1alpha.SanctionEntryStatus": { "type": "string", "title": "SanctionEntryStatus", "enum": [ "SANCTION_ENTRY_STATUS_UNSPECIFIED", "SANCTION_ENTRY_STATUS_CURRENT", "SANCTION_ENTRY_STATUS_FORMER", "SANCTION_ENTRY_STATUS_UNKNOWN" ], "description": "Status of a sanction entry." }, "bndry.api.risk.entities.v1alpha.SanctionEvent": { "type": "object", "properties": { "type": { "title": "type", "description": "The type of sanction event, such as added to, amended on, or removed from\n the sanctions list.", "readOnly": true, "$ref": "#/components/schemas/bndry.api.risk.entities.v1alpha.SanctionEventType" }, "date": { "oneOf": [ { "$ref": "#/components/schemas/google.type.Date" }, { "type": "null" } ], "title": "date", "description": "Date of the event.", "readOnly": true }, "evidenceIds": { "type": "array", "items": { "type": "string", "readOnly": true }, "title": "evidence_ids", "description": "References to supporting evidence documents. Each ID corresponds to an evidence_id in the\n evidence list on the parent Match.", "readOnly": true } }, "title": "SanctionEvent", "additionalProperties": false, "description": "Represents a significant event in the lifecycle of a sanction, such as its initial listing,\n an amendment, or removal." }, "bndry.api.risk.entities.v1alpha.SanctionEventType": { "type": "string", "title": "SanctionEventType", "enum": [ "SANCTION_EVENT_TYPE_UNSPECIFIED", "SANCTION_EVENT_TYPE_ADDED", "SANCTION_EVENT_TYPE_AMENDED", "SANCTION_EVENT_TYPE_REMOVED" ], "description": "Type of sanction lifecycle event." }, "bndry.api.risk.entities.v1alpha.SanctionRegime": { "type": "object", "properties": { "body": { "type": "string", "title": "body", "description": "Name of the sanctioning body (e.g., \"OFAC\", \"EU\", \"UN\").", "readOnly": true }, "name": { "type": [ "string", "null" ], "title": "name", "description": "Name of the sanctions regime or program.", "readOnly": true }, "origin": { "type": [ "string", "null" ], "title": "origin", "description": "The country or international body that administers the sanctions regime.", "readOnly": true }, "types": { "type": "array", "items": { "$ref": "#/components/schemas/bndry.api.risk.entities.v1alpha.SanctionType" }, "title": "types", "description": "The categories of sanction classified by the sanctioning body.", "readOnly": true } }, "title": "SanctionRegime", "additionalProperties": false, "description": "Describes the sanctions regime or program under which an individual has been sanctioned." }, "bndry.api.risk.entities.v1alpha.SanctionType": { "type": "string", "title": "SanctionType", "enum": [ "SANCTION_TYPE_UNSPECIFIED", "SANCTION_TYPE_COUNTER_NARCOTICS", "SANCTION_TYPE_HOSTILE_ACTIVITIES", "SANCTION_TYPE_HUMAN_RIGHTS", "SANCTION_TYPE_NON_PROLIFERATION", "SANCTION_TYPE_TERRITORIAL_VIOLATION", "SANCTION_TYPE_TERRORISM" ], "description": "Classifies the nature or reason for a sanction, as categorized by the sanctioning body." }, "bndry.api.risk.entities.v1alpha.SanctionsInfo": { "type": "object", "properties": { "entries": { "type": "array", "items": { "$ref": "#/components/schemas/bndry.api.risk.entities.v1alpha.SanctionEntry" }, "title": "entries", "description": "Individual sanction listings. Each entry represents a listing by a specific sanctioning body.", "readOnly": true } }, "title": "SanctionsInfo", "additionalProperties": false, "description": "Contains sanctions information for the individual." }, "bndry.api.risk.entities.v1alpha.ScreeningProvider": { "type": "string", "title": "ScreeningProvider", "enum": [ "SCREENING_PROVIDER_UNSPECIFIED", "SCREENING_PROVIDER_RAPIDID", "SCREENING_PROVIDER_KYC6" ], "description": "Identifies the third-party screening provider that performed the screening check." }, "bndry.api.risk.entities.v1alpha.StateOwnedEnterpriseEntry": { "type": "object", "properties": { "level": { "title": "level", "description": "The level of state ownership (e.g., national, local).", "readOnly": true, "$ref": "#/components/schemas/bndry.api.risk.entities.v1alpha.StateOwnedEnterpriseLevel" }, "status": { "title": "status", "description": "Whether the entity is currently or formerly a state-owned enterprise.", "readOnly": true, "$ref": "#/components/schemas/bndry.api.risk.entities.v1alpha.StateOwnedEnterpriseStatus" }, "evidenceIds": { "type": "array", "items": { "type": "string", "readOnly": true }, "title": "evidence_ids", "description": "References to supporting evidence documents.", "readOnly": true } }, "title": "StateOwnedEnterpriseEntry", "additionalProperties": false, "description": "State-owned enterprise classification for a business entity." }, "bndry.api.risk.entities.v1alpha.StateOwnedEnterpriseLevel": { "type": "string", "title": "StateOwnedEnterpriseLevel", "enum": [ "STATE_OWNED_ENTERPRISE_LEVEL_UNSPECIFIED", "STATE_OWNED_ENTERPRISE_LEVEL_NATIONAL", "STATE_OWNED_ENTERPRISE_LEVEL_LOCAL" ], "description": "Level of state ownership for a state-owned enterprise." }, "bndry.api.risk.entities.v1alpha.StateOwnedEnterpriseStatus": { "type": "string", "title": "StateOwnedEnterpriseStatus", "enum": [ "STATE_OWNED_ENTERPRISE_STATUS_UNSPECIFIED", "STATE_OWNED_ENTERPRISE_STATUS_CURRENT", "STATE_OWNED_ENTERPRISE_STATUS_FORMER" ], "description": "Status of a state-owned enterprise classification." }, "bndry.api.risk.entities.v1alpha.Tag": { "type": "object", "properties": { "tagType": { "type": "string", "title": "tag_type", "description": "Required. The tag type resource name.\n Format: tagTypes/{tag_type}" }, "tagDefinitionId": { "type": "string", "title": "tag_definition_id", "description": "Required. The ID of the tag definition within the tag type.\n This must match one of the TagDefinition IDs in the referenced TagType." } }, "title": "Tag", "required": [ "tagType", "tagDefinitionId" ], "additionalProperties": false, "description": "A tag associating a resource with a specific tag type and definition.\n Tags can be applied to resources to categorize and filter them." }, "bndry.api.risk.entities.v1alpha.TokenUsage": { "type": "object", "properties": { "inputTokens": { "type": [ "integer", "string" ], "title": "input_tokens", "format": "int64", "description": "Number of input tokens consumed.", "readOnly": true }, "outputTokens": { "type": [ "integer", "string" ], "title": "output_tokens", "format": "int64", "description": "Number of output tokens generated.", "readOnly": true }, "cacheCreationInputTokens": { "type": [ "integer", "string" ], "title": "cache_creation_input_tokens", "format": "int64", "description": "Number of tokens written to cache (for prompt caching).", "readOnly": true }, "cacheReadInputTokens": { "type": [ "integer", "string" ], "title": "cache_read_input_tokens", "format": "int64", "description": "Number of tokens read from cache (for prompt caching).", "readOnly": true }, "cost": { "type": "number", "title": "cost", "format": "double", "description": "Estimated cost in USD, calculated using Claude Sonnet 4.5 pricing:\n input $3.00/MTok, output $15.00/MTok, cache write $3.75/MTok, cache read $0.30/MTok.", "readOnly": true } }, "title": "TokenUsage", "additionalProperties": false }, "bndry.api.risk.entities.v1alpha.UndeleteActivityLogRequest": { "type": "object", "properties": { "name": { "type": "string", "examples": [ "activityLogs/01234567-89ab-cdef-0123-456789abcdef" ], "title": "name", "description": "Required. The resource name of the activity log to undelete.\n Format: activityLogs/{activity_log}" } }, "title": "UndeleteActivityLogRequest", "required": [ "name" ], "additionalProperties": false, "description": "Request message for [EntityService.UndeleteActivityLog]." }, "bndry.api.risk.entities.v1alpha.UndeleteEntityRequest": { "type": "object", "properties": { "name": { "type": "string", "examples": [ "entities/john-smith-001" ], "title": "name", "description": "Required. The resource name of the entity to undelete.\n Format: entities/{entity}" } }, "title": "UndeleteEntityRequest", "required": [ "name" ], "additionalProperties": false, "description": "Request message for [bndry.api.risk.v1alpha.EntityService.UndeleteEntity]." }, "bndry.api.risk.entities.v1alpha.UpdateActivityLogTypeRequest": { "type": "object", "properties": { "activityLogType": { "title": "activity_log_type", "$ref": "#/components/schemas/bndry.api.risk.entities.v1alpha.ActivityLogType" }, "updateMask": { "title": "update_mask", "description": "(OPTIONAL) Optional. The list of fields to be updated.\n\n If not provided (i.e., the mask is omitted), the server will update all\n fields that are populated in the `activity_log_type` message in this request\n (i.e., fields that have a non-empty value).\n\n The special value `*` can be used for a full replacement of the resource,\n equivalent to a PUT operation. When using `*`, be cautious as new fields\n added to the resource in the future will also be updated.\n\n For robust updates, explicitly specifying the fields is recommended.\n\n See AIP-134 (Standard Update) and AIP-161 (Field Masks) for more details.", "$ref": "#/components/schemas/google.protobuf.FieldMask" } }, "title": "UpdateActivityLogTypeRequest", "required": [ "activityLogType" ], "additionalProperties": false }, "bndry.api.risk.entities.v1alpha.UpdateEntityRequest": { "type": "object", "properties": { "entity": { "title": "entity", "description": "Required. The entity to update.\n\n The entity's `name` field is used to identify the entity to update.\n Format: entities/{entity}", "$ref": "#/components/schemas/bndry.api.risk.entities.v1alpha.Entity" }, "updateMask": { "title": "update_mask", "description": "(OPTIONAL) Optional. The list of fields to be updated.\n\n If not provided (i.e., the mask is omitted), the server will update all\n fields that are populated in the `entity` message in this request\n (i.e., fields that have a non-empty value).\n\n The special value `*` can be used for a full replacement of the resource,\n equivalent to a PUT operation. When using `*`, be cautious as new fields\n added to the resource in the future will also be updated.\n\n For robust updates, explicitly specifying the fields is recommended.\n\n See AIP-134 (Standard Update) and AIP-161 (Field Masks) for more details.", "$ref": "#/components/schemas/google.protobuf.FieldMask" } }, "title": "UpdateEntityRequest", "required": [ "entity" ], "additionalProperties": false, "description": "Request message for [bndry.api.risk.v1alpha.EntityService.UpdateEntity]." }, "bndry.api.risk.entities.v1alpha.VerificationMetadata": { "type": "object", "oneOf": [ { "type": "object", "properties": { "truuth": { "title": "truuth", "description": "Metadata for Truuth verification.", "readOnly": true, "$ref": "#/components/schemas/bndry.api.risk.truuth.v1alpha.TruuthMetadata" } }, "title": "truuth", "required": [ "truuth" ] } ], "title": "VerificationMetadata", "additionalProperties": false }, "bndry.api.risk.entities.v1alpha.ViewEntityRelationshipsRequest": { "type": "object", "properties": { "name": { "type": "string", "examples": [ "entities/john-smith-001" ], "title": "name", "description": "Required. The resource name of the entity for which to view relationships.\n Format: entities/{entity}" }, "view": { "title": "view", "description": "(OPTIONAL) ", "$ref": "#/components/schemas/bndry.api.risk.entities.v1alpha.RelationshipView" } }, "title": "ViewEntityRelationshipsRequest", "required": [ "name" ], "additionalProperties": false, "description": "Request message for [EntityService.ViewEntityRelationships][bndry.api.risk.v1alpha.EntityService.ViewEntityRelationships]." }, "bndry.api.risk.entities.v1alpha.ViewEntityRelationshipsResponse": { "type": "object", "properties": { "entityRelationships": { "type": "array", "items": { "$ref": "#/components/schemas/bndry.api.risk.entities.v1alpha.ViewEntityRelationshipsResponse.EntityRelationships" }, "title": "entity_relationships" } }, "title": "ViewEntityRelationshipsResponse", "additionalProperties": false, "description": "Response message for [EntityService.ViewEntityRelationships][bndry.api.risk.v1alpha.EntityService.ViewEntityRelationships]." }, "bndry.api.risk.entities.v1alpha.ViewEntityRelationshipsResponse.EntityRelationships": { "type": "object", "properties": { "relationshipType": { "title": "relationship_type", "$ref": "#/components/schemas/bndry.api.risk.entities.v1alpha.RelationshipType" }, "name": { "type": "string", "examples": [ "entities/example-financial-services" ], "title": "name", "description": "The resource name of the related entity.\n Format: entities/{entity}" }, "displayName": { "type": "string", "examples": [ "Example Financial Services Ltd" ], "title": "display_name", "description": "(OPTIONAL) Optional. The display name of the related entity." }, "entityType": { "title": "entity_type", "description": "(OPTIONAL) Optional. The type of the related entity.", "$ref": "#/components/schemas/bndry.api.risk.entities.v1alpha.EntityType" } }, "title": "EntityRelationships", "additionalProperties": false }, "bndry.api.risk.rating.v1alpha.ActivityLog": { "type": "object", "properties": { "rules": { "type": "array", "items": { "$ref": "#/components/schemas/bndry.api.risk.rating.v1alpha.Rule" }, "title": "rules", "readOnly": true }, "riskRatingTotal": { "type": "integer", "title": "risk_rating_total", "format": "int32", "description": "aggregate result of all rule", "readOnly": true }, "riskRatingLevel": { "type": "string", "title": "risk_rating_level", "description": "the resulting risk rating label", "readOnly": true }, "riskRating": { "title": "risk_rating", "description": "snapshot of the risk rating at time of evaluation", "readOnly": true, "$ref": "#/components/schemas/bndry.api.risk.rating.v1alpha.RiskRating" }, "riskRatingLevels": { "title": "risk_rating_levels", "description": "snapshot of the risk rating levels at time of evaluation", "readOnly": true, "$ref": "#/components/schemas/bndry.api.risk.rating.v1alpha.RiskRatingLevels" } }, "title": "ActivityLog", "additionalProperties": false }, "bndry.api.risk.rating.v1alpha.Result": { "type": "object", "properties": { "value": { "type": "integer", "title": "value", "format": "int32", "description": "Risk rating value should be int", "readOnly": true }, "cost": { "type": "integer", "title": "cost", "format": "int32", "description": "cost of evaluation", "readOnly": true } }, "title": "Result", "additionalProperties": false }, "bndry.api.risk.rating.v1alpha.RiskRating": { "type": "object", "properties": { "name": { "type": "string", "title": "name", "description": "(IDENTIFIER) " }, "rules": { "type": "array", "items": { "$ref": "#/components/schemas/bndry.api.risk.rating.v1alpha.Rule" }, "title": "rules", "description": "(OPTIONAL) " } }, "title": "RiskRating", "additionalProperties": false }, "bndry.api.risk.rating.v1alpha.RiskRatingLevel": { "type": "object", "properties": { "label": { "type": "string", "title": "label", "maxLength": 63, "minLength": 1, "description": "the label of the risk rating level e.g. \"LOW\", \"MEDIUM\", \"HIGH\"" }, "threshold": { "type": "integer", "title": "threshold", "format": "int32", "description": "the threshold value of the risk rating level" }, "description": { "type": "string", "title": "description", "description": "(OPTIONAL) the description of the risk rating level" }, "color": { "type": "string", "title": "color", "maxLength": 9, "pattern": "^#([0-9a-fA-F]{3,4}|[0-9a-fA-F]{6}|[0-9a-fA-F]{8})$", "description": "(OPTIONAL) the color for UI display in hex format e.g. \"#22c55e\", \"#fff\", or \"#22c55e80\" with alpha" }, "icon": { "type": "string", "title": "icon", "description": "(OPTIONAL) the icon identifier for UI display, one of: circle, check-circle, info-circle, exclamation-triangle, times-circle, question-circle, bell, shield, flag, star" } }, "title": "RiskRatingLevel", "required": [ "label", "threshold" ], "additionalProperties": false }, "bndry.api.risk.rating.v1alpha.RiskRatingLevels": { "type": "object", "properties": { "name": { "type": "string", "title": "name", "description": "(IDENTIFIER) " }, "levels": { "type": "array", "items": { "$ref": "#/components/schemas/bndry.api.risk.rating.v1alpha.RiskRatingLevel" }, "title": "levels", "description": "The risk rating levels ordered by severity ascending (least severe first, most severe last).\n Thresholds must also be in ascending order; an error will be returned if thresholds are not ordered." } }, "title": "RiskRatingLevels", "required": [ "levels" ], "additionalProperties": false }, "bndry.api.risk.rating.v1alpha.Rule": { "type": "object", "properties": { "title": { "type": "string", "title": "title", "minLength": 1, "description": "risk rule title" }, "description": { "type": "string", "title": "description", "description": "(OPTIONAL) risk rule description" }, "expression": { "type": "string", "title": "expression", "description": "CEL expression that must return a numeric result" }, "enabled": { "type": "boolean", "title": "enabled", "description": "(OPTIONAL) enable the rule" }, "results": { "title": "results", "readOnly": true, "$ref": "#/components/schemas/bndry.api.risk.rating.v1alpha.Result" } }, "title": "Rule", "required": [ "title", "expression" ], "additionalProperties": false }, "bndry.api.risk.reporting.v1alpha.Regulator": { "type": "string", "title": "Regulator", "enum": [ "REGULATOR_UNSPECIFIED", "AUSTRAC" ] }, "bndry.api.risk.reporting.v1alpha.RegulatorDetails": { "type": "object", "properties": { "submissionDate": { "title": "submission_date", "description": "Date the report was submitted to the regulator", "$ref": "#/components/schemas/google.type.Date" }, "referenceNumber": { "type": "string", "title": "reference_number", "description": "Reciept number of submitted report" }, "receiptFileId": { "type": "string", "title": "receipt_file_id", "description": "File id of the uploaded receipt/confirmation of submission" }, "regulator": { "title": "regulator", "$ref": "#/components/schemas/bndry.api.risk.reporting.v1alpha.Regulator" } }, "title": "RegulatorDetails", "required": [ "submissionDate", "referenceNumber" ], "additionalProperties": false }, "bndry.api.risk.reporting.v1alpha.ReportDetails": { "type": "object", "properties": { "fileIds": { "type": "array", "items": { "type": "string", "description": "(OPTIONAL) " }, "title": "file_ids", "description": "(OPTIONAL) file_ids of the uploaded report" }, "comments": { "type": "string", "title": "comments", "description": "Additional comments to be included" }, "incidentDate": { "title": "incident_date", "description": "Date the incident occurred", "$ref": "#/components/schemas/google.type.Date" }, "reportedDate": { "title": "reported_date", "description": "Date the incident was reported", "$ref": "#/components/schemas/google.type.Date" }, "documentIds": { "type": "array", "items": { "type": "string", "description": "(OPTIONAL) ", "deprecated": true }, "title": "document_ids", "description": "(OPTIONAL) Deprecated: use file_ids instead", "deprecated": true } }, "title": "ReportDetails", "required": [ "incidentDate", "reportedDate" ], "additionalProperties": false }, "bndry.api.risk.reporting.v1alpha.SMRActivityLog": { "type": "object", "properties": { "reportDetails": { "title": "report_details", "$ref": "#/components/schemas/bndry.api.risk.reporting.v1alpha.ReportDetails" }, "submissionDetails": { "title": "submission_details", "$ref": "#/components/schemas/bndry.api.risk.reporting.v1alpha.RegulatorDetails" } }, "title": "SMRActivityLog", "required": [ "reportDetails", "submissionDetails" ], "additionalProperties": false }, "bndry.api.risk.reporting.v1alpha.UARActivityLog": { "type": "object", "properties": { "reportDetails": { "title": "report_details", "$ref": "#/components/schemas/bndry.api.risk.reporting.v1alpha.ReportDetails" } }, "title": "UARActivityLog", "required": [ "reportDetails" ], "additionalProperties": false }, "bndry.api.risk.truuth.v1alpha.CallbackRequest": { "type": "object", "properties": { "verificationId": { "type": "string", "title": "verification_id", "description": "Unique verification identifier" }, "externalRefId": { "type": "string", "title": "external_ref_id", "description": "Reference identifier for easy identification" }, "status": { "title": "status", "description": "Verification status", "$ref": "#/components/schemas/bndry.api.risk.truuth.v1alpha.VerificationStatus" }, "identityOwner": { "title": "identity_owner", "description": "Identity owner details from verification", "$ref": "#/components/schemas/bndry.api.risk.truuth.v1alpha.WebhookIdentityOwner" }, "results": { "title": "results", "description": "Verification results containing proofing outcomes", "$ref": "#/components/schemas/bndry.api.risk.truuth.v1alpha.VerificationResults" }, "createdAt": { "title": "created_at", "description": "Verification created date-time", "$ref": "#/components/schemas/google.protobuf.Timestamp" } }, "title": "CallbackRequest", "additionalProperties": false, "description": "CallbackRequest represents the webhook payload from Truuth verification completion" }, "bndry.api.risk.truuth.v1alpha.Document": { "type": "object", "properties": { "documentType": { "type": "string", "title": "document_type" }, "documentDisplayName": { "type": "string", "title": "document_display_name" }, "documentClassificationCode": { "type": "string", "title": "document_classification_code" }, "category": { "type": "string", "title": "category" }, "documentData": { "type": "array", "items": { "$ref": "#/components/schemas/bndry.api.risk.truuth.v1alpha.Document.DocumentData" }, "title": "document_data" }, "countryCode": { "type": "string", "title": "country_code" }, "securityChecks": { "type": "array", "items": { "$ref": "#/components/schemas/bndry.api.risk.truuth.v1alpha.SecurityCheck" }, "title": "security_checks" }, "images": { "type": "array", "items": { "type": "string" }, "title": "images" }, "status": { "type": "string", "title": "status" } }, "title": "Document", "additionalProperties": false, "description": "Document represents a verified document" }, "bndry.api.risk.truuth.v1alpha.Document.DocumentData": { "type": "object", "properties": { "key": { "type": "string", "title": "key" }, "value": { "type": "string", "title": "value" }, "confidence": { "type": "number", "title": "confidence", "format": "double" } }, "title": "DocumentData", "additionalProperties": false }, "bndry.api.risk.truuth.v1alpha.OtherCheckOutcome": { "type": "object", "properties": { "type": { "type": "string", "title": "type" }, "name": { "type": "string", "title": "name" }, "status": { "type": "string", "title": "status" } }, "title": "OtherCheckOutcome", "additionalProperties": false, "description": "OtherCheckOutcome represents additional verification checks" }, "bndry.api.risk.truuth.v1alpha.ProofingOutcome": { "type": "object", "properties": { "proofingStatus": { "type": "string", "title": "proofing_status", "description": "Status: PASS, FAIL, WARNING" }, "proofingType": { "title": "proofing_type", "description": "Proofing type details", "$ref": "#/components/schemas/bndry.api.risk.truuth.v1alpha.ProofingType" }, "documents": { "type": "array", "items": { "$ref": "#/components/schemas/bndry.api.risk.truuth.v1alpha.Document" }, "title": "documents", "description": "Document details" }, "userBehaviourChecks": { "type": "array", "items": { "$ref": "#/components/schemas/bndry.api.risk.truuth.v1alpha.UserBehaviorCheck" }, "title": "user_behaviour_checks", "description": "User behavior checks" } }, "title": "ProofingOutcome", "additionalProperties": false, "description": "ProofingOutcome represents a single proofing result" }, "bndry.api.risk.truuth.v1alpha.ProofingType": { "type": "object", "properties": { "code": { "type": "string", "title": "code" }, "name": { "type": "string", "title": "name" } }, "title": "ProofingType", "additionalProperties": false, "description": "ProofingType defines the type of proofing performed" }, "bndry.api.risk.truuth.v1alpha.Report": { "type": "object", "properties": { "type": { "type": "string", "title": "type" }, "url": { "type": "string", "title": "url" }, "metadata": { "type": "object", "title": "metadata", "additionalProperties": { "type": "string", "title": "value" } } }, "title": "Report", "additionalProperties": false, "description": "Report represents additional verification reports" }, "bndry.api.risk.truuth.v1alpha.Report.MetadataEntry": { "type": "object", "properties": { "key": { "type": "string", "title": "key" }, "value": { "type": "string", "title": "value" } }, "title": "MetadataEntry", "additionalProperties": false }, "bndry.api.risk.truuth.v1alpha.SecurityCheck": { "type": "object", "properties": { "type": { "type": "string", "title": "type" }, "name": { "type": "string", "title": "name" }, "status": { "type": "string", "title": "status" }, "score": { "type": "number", "title": "score", "format": "double" }, "subChecks": { "type": "array", "items": { "$ref": "#/components/schemas/bndry.api.risk.truuth.v1alpha.SecurityCheck.SubCheck" }, "title": "sub_checks" } }, "title": "SecurityCheck", "additionalProperties": false }, "bndry.api.risk.truuth.v1alpha.SecurityCheck.SubCheck": { "type": "object", "properties": { "type": { "type": "string", "title": "type" }, "name": { "type": "string", "title": "name" }, "score": { "type": "number", "title": "score", "format": "double" } }, "title": "SubCheck", "additionalProperties": false }, "bndry.api.risk.truuth.v1alpha.TruuthMetadata": { "type": "object", "properties": { "verificationId": { "type": "string", "title": "verification_id", "description": "The unique identifier for the verification session." }, "token": { "type": "string", "title": "token", "description": "The access token required for calling SDK endpoints." } }, "title": "TruuthMetadata", "additionalProperties": false, "description": "TruuthMetadata contains metadata information for Truuth verification processes." }, "bndry.api.risk.truuth.v1alpha.TruuthVerificationConfig": { "type": "object", "properties": { "verificationType": { "title": "verification_type", "$ref": "#/components/schemas/bndry.api.risk.truuth.v1alpha.TruuthVerificationType" } }, "title": "TruuthVerificationConfig", "additionalProperties": false, "description": "TruuthVerificationConfig contains configuration details for Truuth verification." }, "bndry.api.risk.truuth.v1alpha.TruuthVerificationType": { "type": "string", "title": "TruuthVerificationType", "enum": [ "TRUUTH_VERIFICATION_TYPE_UNSPECIFIED", "AUS_ALL", "AUS_CHECK" ], "description": "TruuthVerificationType indicates the type of verification being performed" }, "bndry.api.risk.truuth.v1alpha.UserBehaviorCheck": { "type": "object", "properties": { "type": { "type": "string", "title": "type" }, "name": { "type": "string", "title": "name" }, "status": { "type": "string", "title": "status" }, "score": { "type": "number", "title": "score", "format": "double" } }, "title": "UserBehaviorCheck", "additionalProperties": false, "description": "UserBehaviorCheck represents behavioral verification checks" }, "bndry.api.risk.truuth.v1alpha.VerificationResults": { "type": "object", "properties": { "proofingOutcomes": { "type": "array", "items": { "$ref": "#/components/schemas/bndry.api.risk.truuth.v1alpha.ProofingOutcome" }, "title": "proofing_outcomes", "description": "Proofing outcomes array" }, "otherCheckOutcomes": { "type": "array", "items": { "$ref": "#/components/schemas/bndry.api.risk.truuth.v1alpha.OtherCheckOutcome" }, "title": "other_check_outcomes", "description": "Other check outcomes" }, "faceImage": { "type": "string", "title": "face_image", "description": "Face image URL" }, "reports": { "type": "array", "items": { "$ref": "#/components/schemas/bndry.api.risk.truuth.v1alpha.Report" }, "title": "reports", "description": "Additional reports" } }, "title": "VerificationResults", "additionalProperties": false, "description": "VerificationResults contains the verification outcome details" }, "bndry.api.risk.truuth.v1alpha.VerificationStatus": { "type": "string", "title": "VerificationStatus", "enum": [ "VERIFICATION_STATUS_UNSPECIFIED", "VERIFICATION_STATUS_DONE", "VERIFICATION_STATUS_IN_PROGRESS", "VERIFICATION_STATUS_PROCESSING", "VERIFICATION_STATUS_ERROR" ], "description": "VerificationStatus indicates the current status of the verification" }, "bndry.api.risk.truuth.v1alpha.WebhookIdentityOwner": { "type": "object", "properties": { "givenName": { "type": "string", "title": "given_name" }, "familyName": { "type": "string", "title": "family_name" }, "middleName": { "type": "string", "title": "middle_name" }, "dateOfBirth": { "type": "string", "title": "date_of_birth" }, "email": { "type": "string", "title": "email" }, "gender": { "type": "string", "title": "gender" }, "mobileNumber": { "type": "string", "title": "mobile_number" } }, "title": "WebhookIdentityOwner", "additionalProperties": false, "description": "WebhookIdentityOwner contains identity details from webhook" }, "connect-protocol-version": { "type": "number", "title": "Connect-Protocol-Version", "enum": [ 1 ], "description": "Define the version of the Connect protocol", "const": 1 }, "connect-timeout-header": { "type": "number", "title": "Connect-Timeout-Ms", "description": "Define the timeout, in ms" }, "connect.error": { "type": "object", "properties": { "code": { "type": "string", "examples": [ "not_found" ], "enum": [ "canceled", "unknown", "invalid_argument", "deadline_exceeded", "not_found", "already_exists", "permission_denied", "resource_exhausted", "failed_precondition", "aborted", "out_of_range", "unimplemented", "internal", "unavailable", "data_loss", "unauthenticated" ], "description": "The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code]." }, "message": { "type": "string", "description": "A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client." }, "details": { "type": "array", "items": { "$ref": "#/components/schemas/connect.error_details.Any" }, "description": "A list of messages that carry the error details. There is no limit on the number of messages." } }, "title": "Connect Error", "additionalProperties": true, "description": "Error type returned by Connect: https://connectrpc.com/docs/go/errors/#http-representation" }, "connect.error_details.Any": { "type": "object", "properties": { "type": { "type": "string", "description": "A URL that acts as a globally unique identifier for the type of the serialized message. For example: `type.googleapis.com/google.rpc.ErrorInfo`. This is used to determine the schema of the data in the `value` field and is the discriminator for the `debug` field." }, "value": { "type": "string", "format": "binary", "description": "The Protobuf message, serialized as bytes and base64-encoded. The specific message type is identified by the `type` field." }, "debug": { "oneOf": [ { "type": "object", "title": "Any", "additionalProperties": true, "description": "Detailed error information." } ], "discriminator": { "propertyName": "type" }, "title": "Debug", "description": "Deserialized error detail payload. The 'type' field indicates the schema. This field is for easier debugging and should not be relied upon for application logic." } }, "additionalProperties": true, "description": "Contains an arbitrary serialized message along with a @type that describes the type of the serialized message, with an additional debug field for ConnectRPC error details." }, "google.longrunning.GetOperationRequest": { "type": "object", "properties": { "name": { "type": "string", "title": "name", "description": "The name of the operation resource." } }, "title": "GetOperationRequest", "additionalProperties": false, "description": "The request message for\n [Operations.GetOperation][google.longrunning.Operations.GetOperation]." }, "google.longrunning.Operation": { "type": "object", "allOf": [ { "properties": { "name": { "type": "string", "title": "name", "description": "The server-assigned name, which is only unique within the same service that\n originally returns it. If you use the default HTTP mapping, the\n `name` should be a resource name ending with `operations/{unique_id}`." }, "metadata": { "title": "metadata", "description": "Service-specific metadata associated with the operation. It typically\n contains progress information and common metadata such as create time.\n Some services might not provide such metadata. Any method that returns a\n long-running operation should document the metadata type, if any.", "$ref": "#/components/schemas/google.protobuf.Any" }, "done": { "type": "boolean", "title": "done", "description": "If the value is `false`, it means the operation is still in progress.\n If `true`, the operation is completed, and either `error` or `response` is\n available." } } }, { "oneOf": [ { "type": "object", "properties": { "error": { "title": "error", "description": "The error result of the operation in case of failure or cancellation.", "$ref": "#/components/schemas/google.rpc.Status" } }, "title": "error", "required": [ "error" ] }, { "type": "object", "properties": { "response": { "title": "response", "description": "The normal, successful response of the operation. If the original\n method returns no data on success, such as `Delete`, the response is\n `google.protobuf.Empty`. If the original method is standard\n `Get`/`Create`/`Update`, the response should be the resource. For other\n methods, the response should have the type `XxxResponse`, where `Xxx`\n is the original method name. For example, if the original method name\n is `TakeSnapshot()`, the inferred response type is\n `TakeSnapshotResponse`.", "$ref": "#/components/schemas/google.protobuf.Any" } }, "title": "response", "required": [ "response" ] } ] } ], "title": "Operation", "additionalProperties": false, "description": "This resource represents a long-running operation that is the result of a\n network API call." }, "google.protobuf.Any": { "type": "object", "properties": { "type": { "type": "string" }, "value": { "type": "string", "format": "binary" } }, "additionalProperties": true, "description": "Contains an arbitrary serialized message along with a @type that describes the type of the serialized message." }, "google.protobuf.Empty": { "type": "object", "description": "A generic empty message that you can re-use to avoid defining duplicated\n empty messages in your APIs. A typical example is to use it as the request\n or the response type of an API method. For instance:\n\n service Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n }" }, "google.protobuf.FieldMask": { "type": "string", "description": "`FieldMask` represents a set of symbolic field paths, for example:\n\n paths: \"f.a\"\n paths: \"f.b.d\"\n\n Here `f` represents a field in some root message, `a` and `b`\n fields in the message found in `f`, and `d` a field found in the\n message in `f.b`.\n\n Field masks are used to specify a subset of fields that should be\n returned by a get operation or modified by an update operation.\n Field masks also have a custom JSON encoding (see below).\n\n # Field Masks in Projections\n\n When used in the context of a projection, a response message or\n sub-message is filtered by the API to only contain those fields as\n specified in the mask. For example, if the mask in the previous\n example is applied to a response message as follows:\n\n f {\n a : 22\n b {\n d : 1\n x : 2\n }\n y : 13\n }\n z: 8\n\n The result will not contain specific values for fields x,y and z\n (their value will be set to the default, and omitted in proto text\n output):\n\n\n f {\n a : 22\n b {\n d : 1\n }\n }\n\n A repeated field is not allowed except at the last position of a\n paths string.\n\n If a FieldMask object is not present in a get operation, the\n operation applies to all fields (as if a FieldMask of all fields\n had been specified).\n\n Note that a field mask does not necessarily apply to the\n top-level response message. In case of a REST get operation, the\n field mask applies directly to the response, but in case of a REST\n list operation, the mask instead applies to each individual message\n in the returned resource list. In case of a REST custom method,\n other definitions may be used. Where the mask applies will be\n clearly documented together with its declaration in the API. In\n any case, the effect on the returned resource/resources is required\n behavior for APIs.\n\n # Field Masks in Update Operations\n\n A field mask in update operations specifies which fields of the\n targeted resource are going to be updated. The API is required\n to only change the values of the fields as specified in the mask\n and leave the others untouched. If a resource is passed in to\n describe the updated values, the API ignores the values of all\n fields not covered by the mask.\n\n If a repeated field is specified for an update operation, new values will\n be appended to the existing repeated field in the target resource. Note that\n a repeated field is only allowed in the last position of a `paths` string.\n\n If a sub-message is specified in the last position of the field mask for an\n update operation, then new value will be merged into the existing sub-message\n in the target resource.\n\n For example, given the target message:\n\n f {\n b {\n d: 1\n x: 2\n }\n c: [1]\n }\n\n And an update message:\n\n f {\n b {\n d: 10\n }\n c: [2]\n }\n\n then if the field mask is:\n\n paths: [\"f.b\", \"f.c\"]\n\n then the result will be:\n\n f {\n b {\n d: 10\n x: 2\n }\n c: [1, 2]\n }\n\n An implementation may provide options to override this default behavior for\n repeated and message fields.\n\n In order to reset a field's value to the default, the field must\n be in the mask and set to the default value in the provided resource.\n Hence, in order to reset all fields of a resource, provide a default\n instance of the resource and set all fields in the mask, or do\n not provide a mask as described below.\n\n If a field mask is not present on update, the operation applies to\n all fields (as if a field mask of all fields has been specified).\n Note that in the presence of schema evolution, this may mean that\n fields the client does not know and has therefore not filled into\n the request will be reset to their default. If this is unwanted\n behavior, a specific service may require a client to always specify\n a field mask, producing an error if not.\n\n As with get operations, the location of the resource which\n describes the updated values in the request message depends on the\n operation kind. In any case, the effect of the field mask is\n required to be honored by the API.\n\n ## Considerations for HTTP REST\n\n The HTTP kind of an update operation which uses a field mask must\n be set to PATCH instead of PUT in order to satisfy HTTP semantics\n (PUT must only be used for full updates).\n\n # JSON Encoding of Field Masks\n\n In JSON, a field mask is encoded as a single string where paths are\n separated by a comma. Fields name in each path are converted\n to/from lower-camel naming conventions.\n\n As an example, consider the following message declarations:\n\n message Profile {\n User user = 1;\n Photo photo = 2;\n }\n message User {\n string display_name = 1;\n string address = 2;\n }\n\n In proto a field mask for `Profile` may look as such:\n\n mask {\n paths: \"user.display_name\"\n paths: \"photo\"\n }\n\n In JSON, the same mask is represented as below:\n\n {\n mask: \"user.displayName,photo\"\n }\n\n # Field Masks and Oneof Fields\n\n Field masks treat fields in oneofs just as regular fields. Consider the\n following message:\n\n message SampleMessage {\n oneof test_oneof {\n string name = 4;\n SubMessage sub_message = 9;\n }\n }\n\n The field mask can be:\n\n mask {\n paths: \"name\"\n }\n\n Or:\n\n mask {\n paths: \"sub_message\"\n }\n\n Note that oneof type names (\"test_oneof\" in this case) cannot be used in\n paths.\n\n ## Field Mask Verification\n\n The implementation of any API method which has a FieldMask type field in the\n request should verify the included field paths, and return an\n `INVALID_ARGUMENT` error if any path is unmappable." }, "google.protobuf.ListValue": { "type": "object", "properties": { "values": { "type": "array", "items": { "$ref": "#/components/schemas/google.protobuf.Value" }, "title": "values", "description": "Repeated field of dynamically typed values." } }, "title": "ListValue", "additionalProperties": false, "description": "`ListValue` is a wrapper around a repeated field of values.\n\n The JSON representation for `ListValue` is JSON array." }, "google.protobuf.NullValue": { "type": "string", "title": "NullValue", "enum": [ "NULL_VALUE" ], "description": "`NullValue` is a singleton enumeration to represent the null value for the\n `Value` type union.\n\n The JSON representation for `NullValue` is JSON `null`." }, "google.protobuf.Struct": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/google.protobuf.Value" }, "description": "`Struct` represents a structured data value, consisting of fields\n which map to dynamically typed values. In some languages, `Struct`\n might be supported by a native representation. For example, in\n scripting languages like JS a struct is represented as an\n object. The details of that representation are described together\n with the proto support for the language.\n\n The JSON representation for `Struct` is JSON object." }, "google.protobuf.Struct.FieldsEntry": { "type": "object", "properties": { "key": { "type": "string", "title": "key" }, "value": { "title": "value", "$ref": "#/components/schemas/google.protobuf.Value" } }, "title": "FieldsEntry", "additionalProperties": false }, "google.protobuf.Timestamp": { "type": "string", "examples": [ "2023-01-15T01:30:15.01Z", "2024-12-25T12:00:00Z" ], "format": "date-time", "description": "A Timestamp represents a point in time independent of any time zone or local\n calendar, encoded as a count of seconds and fractions of seconds at\n nanosecond resolution. The count is relative to an epoch at UTC midnight on\n January 1, 1970, in the proleptic Gregorian calendar which extends the\n Gregorian calendar backwards to year one.\n\n All minutes are 60 seconds long. Leap seconds are \"smeared\" so that no leap\n second table is needed for interpretation, using a [24-hour linear\n smear](https://developers.google.com/time/smear).\n\n The range is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z. By\n restricting to that range, we ensure that we can convert to and from [RFC\n 3339](https://www.ietf.org/rfc/rfc3339.txt) date strings.\n\n # Examples\n\n Example 1: Compute Timestamp from POSIX `time()`.\n\n Timestamp timestamp;\n timestamp.set_seconds(time(NULL));\n timestamp.set_nanos(0);\n\n Example 2: Compute Timestamp from POSIX `gettimeofday()`.\n\n struct timeval tv;\n gettimeofday(&tv, NULL);\n\n Timestamp timestamp;\n timestamp.set_seconds(tv.tv_sec);\n timestamp.set_nanos(tv.tv_usec * 1000);\n\n Example 3: Compute Timestamp from Win32 `GetSystemTimeAsFileTime()`.\n\n FILETIME ft;\n GetSystemTimeAsFileTime(&ft);\n UINT64 ticks = (((UINT64)ft.dwHighDateTime) << 32) | ft.dwLowDateTime;\n\n // A Windows tick is 100 nanoseconds. Windows epoch 1601-01-01T00:00:00Z\n // is 11644473600 seconds before Unix epoch 1970-01-01T00:00:00Z.\n Timestamp timestamp;\n timestamp.set_seconds((INT64) ((ticks / 10000000) - 11644473600LL));\n timestamp.set_nanos((INT32) ((ticks % 10000000) * 100));\n\n Example 4: Compute Timestamp from Java `System.currentTimeMillis()`.\n\n long millis = System.currentTimeMillis();\n\n Timestamp timestamp = Timestamp.newBuilder().setSeconds(millis / 1000)\n .setNanos((int) ((millis % 1000) * 1000000)).build();\n\n Example 5: Compute Timestamp from Java `Instant.now()`.\n\n Instant now = Instant.now();\n\n Timestamp timestamp =\n Timestamp.newBuilder().setSeconds(now.getEpochSecond())\n .setNanos(now.getNano()).build();\n\n Example 6: Compute Timestamp from current time in Python.\n\n timestamp = Timestamp()\n timestamp.GetCurrentTime()\n\n # JSON Mapping\n\n In JSON format, the Timestamp type is encoded as a string in the\n [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format. That is, the\n format is \"{year}-{month}-{day}T{hour}:{min}:{sec}[.{frac_sec}]Z\"\n where {year} is always expressed using four digits while {month}, {day},\n {hour}, {min}, and {sec} are zero-padded to two digits each. The fractional\n seconds, which can go up to 9 digits (i.e. up to 1 nanosecond resolution),\n are optional. The \"Z\" suffix indicates the timezone (\"UTC\"); the timezone\n is required. A proto3 JSON serializer should always use UTC (as indicated by\n \"Z\") when printing the Timestamp type and a proto3 JSON parser should be\n able to accept both UTC and other timezones (as indicated by an offset).\n\n For example, \"2017-01-15T01:30:15.01Z\" encodes 15.01 seconds past\n 01:30 UTC on January 15, 2017.\n\n In JavaScript, one can convert a Date object to this format using the\n standard\n [toISOString()](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString)\n method. In Python, a standard `datetime.datetime` object can be converted\n to this format using\n [`strftime`](https://docs.python.org/2/library/time.html#time.strftime) with\n the time format spec '%Y-%m-%dT%H:%M:%S.%fZ'. Likewise, in Java, one can use\n the Joda Time's [`ISODateTimeFormat.dateTime()`](\n http://joda-time.sourceforge.net/apidocs/org/joda/time/format/ISODateTimeFormat.html#dateTime()\n ) to obtain a formatter capable of generating timestamps in this format." }, "google.protobuf.Value": { "oneOf": [ { "type": "null" }, { "type": "number" }, { "type": "string" }, { "type": "boolean" }, { "type": "array" }, { "type": "object", "additionalProperties": true } ], "description": "`Value` represents a dynamically typed value which can be either\n null, a number, a string, a boolean, a recursive struct value, or a\n list of values. A producer of value is expected to set one of these\n variants. Absence of any variant indicates an error.\n\n The JSON representation for `Value` is JSON value." }, "google.rpc.Status": { "type": "object", "properties": { "code": { "type": "integer", "title": "code", "format": "int32", "description": "The status code, which should be an enum value of\n [google.rpc.Code][google.rpc.Code]." }, "message": { "type": "string", "title": "message", "description": "A developer-facing error message, which should be in English. Any\n user-facing error message should be localized and sent in the\n [google.rpc.Status.details][google.rpc.Status.details] field, or localized\n by the client." }, "details": { "type": "array", "items": { "$ref": "#/components/schemas/google.protobuf.Any" }, "title": "details", "description": "A list of messages that carry the error details. There is a common set of\n message types for APIs to use." } }, "title": "Status", "additionalProperties": false, "description": "The `Status` type defines a logical error model that is suitable for\n different programming environments, including REST APIs and RPC APIs. It is\n used by [gRPC](https://github.com/grpc). Each `Status` message contains\n three pieces of data: error code, error message, and error details.\n\n You can find out more about this error model and how to work with it in the\n [API Design Guide](https://cloud.google.com/apis/design/errors)." }, "google.type.Date": { "type": "object", "properties": { "year": { "type": "integer", "title": "year", "format": "int32", "description": "Year of the date. Must be from 1 to 9999, or 0 to specify a date without\n a year." }, "month": { "type": "integer", "title": "month", "format": "int32", "description": "Month of a year. Must be from 1 to 12, or 0 to specify a year without a\n month and day." }, "day": { "type": "integer", "title": "day", "format": "int32", "description": "Day of a month. Must be from 1 to 31 and valid for the year and month, or 0\n to specify a year by itself or a year and month where the day isn't\n significant." } }, "title": "Date", "additionalProperties": false, "description": "Represents a whole or partial calendar date, such as a birthday. The time of\n day and time zone are either specified elsewhere or are insignificant. The\n date is relative to the Gregorian Calendar. This can represent one of the\n following:\n\n * A full date, with non-zero year, month, and day values\n * A month and day value, with a zero year, such as an anniversary\n * A year on its own, with zero month and day values\n * A year and month value, with a zero day, such as a credit card expiration\n date\n\n Related types are [google.type.TimeOfDay][google.type.TimeOfDay] and\n `google.protobuf.Timestamp`." }, "google.type.PostalAddress": { "type": "object", "properties": { "revision": { "type": "integer", "title": "revision", "format": "int32", "description": "The schema revision of the `PostalAddress`. This must be set to 0, which is\n the latest revision.\n\n All new revisions **must** be backward compatible with old revisions." }, "regionCode": { "type": "string", "title": "region_code", "description": "Required. CLDR region code of the country/region of the address. This\n is never inferred and it is up to the user to ensure the value is\n correct. See http://cldr.unicode.org/ and\n http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html\n for details. Example: \"CH\" for Switzerland." }, "languageCode": { "type": "string", "title": "language_code", "description": "Optional. BCP-47 language code of the contents of this address (if\n known). This is often the UI language of the input form or is expected\n to match one of the languages used in the address' country/region, or their\n transliterated equivalents.\n This can affect formatting in certain countries, but is not critical\n to the correctness of the data and will never affect any validation or\n other non-formatting related operations.\n\n If this value is not known, it should be omitted (rather than specifying a\n possibly incorrect default).\n\n Examples: \"zh-Hant\", \"ja\", \"ja-Latn\", \"en\"." }, "postalCode": { "type": "string", "title": "postal_code", "description": "Optional. Postal code of the address. Not all countries use or require\n postal codes to be present, but where they are used, they may trigger\n additional validation with other parts of the address (e.g. state/zip\n validation in the U.S.A.)." }, "sortingCode": { "type": "string", "title": "sorting_code", "description": "Optional. Additional, country-specific, sorting code. This is not used\n in most regions. Where it is used, the value is either a string like\n \"CEDEX\", optionally followed by a number (e.g. \"CEDEX 7\"), or just a number\n alone, representing the \"sector code\" (Jamaica), \"delivery area indicator\"\n (Malawi) or \"post office indicator\" (e.g. Côte d'Ivoire)." }, "administrativeArea": { "type": "string", "title": "administrative_area", "description": "Optional. Highest administrative subdivision which is used for postal\n addresses of a country or region.\n For example, this can be a state, a province, an oblast, or a prefecture.\n Specifically, for Spain this is the province and not the autonomous\n community (e.g. \"Barcelona\" and not \"Catalonia\").\n Many countries don't use an administrative area in postal addresses. E.g.\n in Switzerland this should be left unpopulated." }, "locality": { "type": "string", "title": "locality", "description": "Optional. Generally refers to the city/town portion of the address.\n Examples: US city, IT comune, UK post town.\n In regions of the world where localities are not well defined or do not fit\n into this structure well, leave locality empty and use address_lines." }, "sublocality": { "type": "string", "title": "sublocality", "description": "Optional. Sublocality of the address.\n For example, this can be neighborhoods, boroughs, districts." }, "addressLines": { "type": "array", "items": { "type": "string" }, "title": "address_lines", "description": "Unstructured address lines describing the lower levels of an address.\n\n Because values in address_lines do not have type information and may\n sometimes contain multiple values in a single field (e.g.\n \"Austin, TX\"), it is important that the line order is clear. The order of\n address lines should be \"envelope order\" for the country/region of the\n address. In places where this can vary (e.g. Japan), address_language is\n used to make it explicit (e.g. \"ja\" for large-to-small ordering and\n \"ja-Latn\" or \"en\" for small-to-large). This way, the most specific line of\n an address can be selected based on the language.\n\n The minimum permitted structural representation of an address consists\n of a region_code with all remaining information placed in the\n address_lines. It would be possible to format such an address very\n approximately without geocoding, but no semantic reasoning could be\n made about any of the address components until it was at least\n partially resolved.\n\n Creating an address only containing a region_code and address_lines, and\n then geocoding is the recommended way to handle completely unstructured\n addresses (as opposed to guessing which parts of the address should be\n localities or administrative areas)." }, "recipients": { "type": "array", "items": { "type": "string" }, "title": "recipients", "description": "Optional. The recipient at the address.\n This field may, under certain circumstances, contain multiline information.\n For example, it might contain \"care of\" information." }, "organization": { "type": "string", "title": "organization", "description": "Optional. The name of the organization at the address." } }, "title": "PostalAddress", "additionalProperties": false, "description": "Represents a postal address, e.g. for postal delivery or payments addresses.\n Given a postal address, a postal service can deliver items to a premise, P.O.\n Box or similar.\n It is not intended to model geographical locations (roads, towns,\n mountains).\n\n In typical usage an address would be created via user input or from importing\n existing data, depending on the type of process.\n\n Advice on address input / editing:\n - Use an i18n-ready address widget such as\n https://github.com/google/libaddressinput)\n - Users should not be presented with UI elements for input or editing of\n fields outside countries where that field is used.\n\n For more guidance on how to use this schema, please see:\n https://support.google.com/business/answer/6397478" }, "hawk.v1alpha.CheckCustomerResponse": { "type": "object", "properties": { "caseId": { "type": "string", "title": "case_id", "description": "Unique identifier for the case (UUID format)" }, "customerId": { "type": "string", "title": "customer_id", "description": "Unique identifier for the customer" }, "flaggingResults": { "type": "array", "items": { "$ref": "#/components/schemas/hawk.v1alpha.CheckCustomerResponse.FlaggingResult" }, "title": "flagging_results" }, "riskFactors": { "type": "array", "items": { "$ref": "#/components/schemas/hawk.v1alpha.CheckCustomerResponse.RiskFactorsResult" }, "title": "risk_factors" }, "riskLevel": { "type": "string", "title": "risk_level" }, "screeningResults": { "type": "array", "items": { "$ref": "#/components/schemas/hawk.v1alpha.CheckCustomerResponse.ScreeningResult" }, "title": "screening_results" } }, "title": "CheckCustomerResponse", "additionalProperties": false }, "hawk.v1alpha.CheckCustomerResponse.FlaggingResult": { "type": "object", "properties": { "flag": { "type": "string", "title": "flag", "description": "Name of the flag" } }, "title": "FlaggingResult", "additionalProperties": false }, "hawk.v1alpha.CheckCustomerResponse.RiskFactorsResult": { "type": "object", "properties": { "factor": { "type": "string", "title": "factor", "description": "Name of risk factor being checked" } }, "title": "RiskFactorsResult", "additionalProperties": false }, "hawk.v1alpha.CheckCustomerResponse.ScreeningResult": { "type": "object", "properties": { "type": { "title": "type", "$ref": "#/components/schemas/hawk.v1alpha.ScreeningType" } }, "title": "ScreeningResult", "additionalProperties": false }, "hawk.v1alpha.ScreeningType": { "type": "string", "title": "ScreeningType", "enum": [ "SCREENING_TYPE_UNSPECIFIED", "SCREENING_TYPE_SPECIAL_INTEREST_PERSON", "SCREENING_TYPE_SANCTIONED_ENTITY", "SCREENING_TYPE_PEP" ], "description": "Possible screening result types" }, "kyc6.business.v1alpha.ActivityLog": { "type": "object", "properties": { "matches": { "type": "array", "items": { "$ref": "#/components/schemas/kyc6.business.v1alpha.ResultAndProfile" }, "title": "matches", "description": "Search results paired with their corresponding business profiles" } }, "title": "ActivityLog", "additionalProperties": false }, "kyc6.business.v1alpha.BusinessAddress": { "type": "object", "properties": { "addressType": { "title": "address_type", "$ref": "#/components/schemas/kyc6.business.v1alpha.BusinessAddressType" }, "line1": { "type": [ "string", "null" ], "title": "line1" }, "line2": { "type": [ "string", "null" ], "title": "line2" }, "postcode": { "type": [ "string", "null" ], "title": "postcode" }, "city": { "type": [ "string", "null" ], "title": "city" }, "county": { "type": [ "string", "null" ], "title": "county" }, "countyAbbrev": { "type": [ "string", "null" ], "title": "county_abbrev" }, "countryIsoCode": { "type": "string", "title": "country_iso_code" } }, "title": "BusinessAddress", "additionalProperties": false, "description": "Business address information" }, "kyc6.business.v1alpha.BusinessAddressType": { "type": "string", "title": "BusinessAddressType", "enum": [ "BUSINESS_ADDRESS_TYPE_UNSPECIFIED", "BUSINESS_ADDRESS_TYPE_REGISTERED", "BUSINESS_ADDRESS_TYPE_OPERATING", "BUSINESS_ADDRESS_TYPE_PREVIOUS", "BUSINESS_ADDRESS_TYPE_BRANCH_OFFICE", "BUSINESS_ADDRESS_TYPE_REPRESENTATIVE_OFFICE", "BUSINESS_ADDRESS_TYPE_HEADQUARTERS" ] }, "kyc6.business.v1alpha.BusinessAlias": { "type": "object", "properties": { "alias": { "type": "string", "title": "alias" }, "type": { "title": "type", "$ref": "#/components/schemas/kyc6.business.v1alpha.BusinessAliasType" } }, "title": "BusinessAlias", "additionalProperties": false, "description": "Business alias information (alias string + type)" }, "kyc6.business.v1alpha.BusinessAliasType": { "type": "string", "title": "BusinessAliasType", "enum": [ "BUSINESS_ALIAS_TYPE_UNSPECIFIED", "BUSINESS_ALIAS_TYPE_ORIGINAL_SCRIPT_NAME", "BUSINESS_ALIAS_TYPE_NAME_SPELLING_VARIATION", "BUSINESS_ALIAS_TYPE_NAME_ABBREVIATION", "BUSINESS_ALIAS_TYPE_PREVIOUS_NAME", "BUSINESS_ALIAS_TYPE_BRAND_NAME", "BUSINESS_ALIAS_TYPE_FAKE_NAME" ] }, "kyc6.business.v1alpha.BusinessContactEntry": { "type": "object", "properties": { "category": { "title": "category", "$ref": "#/components/schemas/kyc6.business.v1alpha.BusinessContactEntryCategory" }, "value": { "type": "string", "title": "value" } }, "title": "BusinessContactEntry", "additionalProperties": false, "description": "Business contact entry (Telephone, Fax, Website)" }, "kyc6.business.v1alpha.BusinessContactEntryCategory": { "type": "string", "title": "BusinessContactEntryCategory", "enum": [ "BUSINESS_CONTACT_ENTRY_CATEGORY_UNSPECIFIED", "BUSINESS_CONTACT_ENTRY_CATEGORY_TELEPHONE", "BUSINESS_CONTACT_ENTRY_CATEGORY_FAX", "BUSINESS_CONTACT_ENTRY_CATEGORY_WEBSITE" ] }, "kyc6.business.v1alpha.BusinessDeletionReason": { "type": "object", "properties": { "reason": { "title": "reason", "$ref": "#/components/schemas/kyc6.business.v1alpha.BusinessDeletionReasonType" }, "otherReason": { "type": [ "string", "null" ], "title": "other_reason", "description": "Populated when reason is Other" } }, "title": "BusinessDeletionReason", "additionalProperties": false, "description": "Deletion reason information for business profiles" }, "kyc6.business.v1alpha.BusinessDeletionReasonType": { "type": "string", "title": "BusinessDeletionReasonType", "enum": [ "BUSINESS_DELETION_REASON_TYPE_UNSPECIFIED", "BUSINESS_DELETION_REASON_TYPE_GOVERNMENT_POSITION_OUT_OF_SCOPE", "BUSINESS_DELETION_REASON_TYPE_ADVERSE_MEDIA_CATEGORY_OUT_OF_SCOPE", "BUSINESS_DELETION_REASON_TYPE_DUPLICATE_PROFILE", "BUSINESS_DELETION_REASON_TYPE_REDUNDANT_PROFILE", "BUSINESS_DELETION_REASON_TYPE_EXPIRED_RISK_RELEVANCE", "BUSINESS_DELETION_REASON_TYPE_OTHER" ] }, "kyc6.business.v1alpha.BusinessEvidence": { "type": "object", "properties": { "evidenceId": { "type": "string", "title": "evidence_id" }, "originalUrl": { "type": "string", "title": "original_url" }, "isCopyrighted": { "type": "boolean", "title": "is_copyrighted" }, "title": { "type": [ "string", "null" ], "title": "title" }, "credibility": { "oneOf": [ { "$ref": "#/components/schemas/kyc6.common.v1alpha.EvidenceCredibility" }, { "type": "null" } ], "title": "credibility" }, "language": { "type": [ "string", "null" ], "title": "language" }, "summary": { "type": [ "string", "null" ], "title": "summary" }, "keywords": { "type": [ "string", "null" ], "title": "keywords" }, "captureDateIso": { "type": [ "string", "null" ], "title": "capture_date_iso" }, "publicationDateIso": { "type": [ "string", "null" ], "title": "publication_date_iso" }, "assetUrl": { "type": [ "string", "null" ], "title": "asset_url" }, "datasets": { "type": "array", "items": { "$ref": "#/components/schemas/kyc6.business.v1alpha.BusinessEvidenceDataset" }, "title": "datasets" } }, "title": "BusinessEvidence", "additionalProperties": false, "description": "Evidence information for business profiles (uses BusinessEvidenceDataset for datasets)" }, "kyc6.business.v1alpha.BusinessEvidenceDataset": { "type": "string", "title": "BusinessEvidenceDataset", "enum": [ "BUSINESS_EVIDENCE_DATASET_UNSPECIFIED", "BUSINESS_EVIDENCE_DATASET_SAN_CURRENT", "BUSINESS_EVIDENCE_DATASET_SAN_FORMER", "BUSINESS_EVIDENCE_DATASET_INS", "BUSINESS_EVIDENCE_DATASET_RRE", "BUSINESS_EVIDENCE_DATASET_POI", "BUSINESS_EVIDENCE_DATASET_REL", "BUSINESS_EVIDENCE_DATASET_SOE_CURRENT", "BUSINESS_EVIDENCE_DATASET_SOE_FORMER", "BUSINESS_EVIDENCE_DATASET_GRI", "BUSINESS_EVIDENCE_DATASET_ID", "BUSINESS_EVIDENCE_DATASET_CORP", "BUSINESS_EVIDENCE_DATASET_PEP_CURRENT" ], "description": "Evidence dataset types for business (SAN-CURRENT, RRE, SOE-CURRENT, etc.)" }, "kyc6.business.v1alpha.BusinessLinkedBusiness": { "type": "object", "properties": { "qrCode": { "type": "string", "title": "qr_code" }, "name": { "type": "string", "title": "name" }, "resourceUri": { "type": "string", "title": "resource_uri" }, "resourceId": { "type": "string", "title": "resource_id" }, "relationship": { "type": "string", "title": "relationship" }, "ownershipPercentage": { "type": [ "integer", "null" ], "title": "ownership_percentage", "format": "int32" }, "datasets": { "type": "array", "items": { "$ref": "#/components/schemas/kyc6.common.v1alpha.BusinessProfileDataset" }, "title": "datasets" }, "individualLinks": { "type": "array", "items": { "$ref": "#/components/schemas/kyc6.business.v1alpha.BusinessLinkedIndividual" }, "title": "individual_links" } }, "title": "BusinessLinkedBusiness", "additionalProperties": false, "description": "Linked business information" }, "kyc6.business.v1alpha.BusinessLinkedIndividual": { "type": "object", "properties": { "qrCode": { "type": "string", "title": "qr_code" }, "firstName": { "type": [ "string", "null" ], "title": "first_name" }, "middleName": { "type": [ "string", "null" ], "title": "middle_name" }, "lastName": { "type": "string", "title": "last_name" }, "relationship": { "type": "string", "title": "relationship" }, "ownershipPercentage": { "type": [ "integer", "null" ], "title": "ownership_percentage", "format": "int32" }, "resourceUri": { "type": "string", "title": "resource_uri" }, "resourceId": { "type": "string", "title": "resource_id" }, "datasets": { "type": "array", "items": { "$ref": "#/components/schemas/kyc6.common.v1alpha.IndividualProfileDataset" }, "title": "datasets" } }, "title": "BusinessLinkedIndividual", "additionalProperties": false, "description": "Linked individual information (when embedded in business profile)" }, "kyc6.business.v1alpha.BusinessProfile": { "type": "object", "properties": { "qrCode": { "type": "string", "title": "qr_code", "description": "The unique Quick Reference code of the business" }, "version": { "type": [ "integer", "string" ], "title": "version", "format": "int64", "description": "The version number can be used by clients to detect when a profile has changed" }, "resourceUri": { "type": "string", "title": "resource_uri", "description": "The resource URI can be used to query the API to retrieve the profile" }, "resourceId": { "type": "string", "title": "resource_id", "description": "The resource ID can be used to retrieve the full profile or the PDF" }, "name": { "type": "string", "title": "name", "description": "The full name of the business" }, "description": { "type": [ "string", "null" ], "title": "description", "description": "Additional information related to the nature of the business" }, "isDeleted": { "type": "boolean", "title": "is_deleted", "description": "Indicates if the business has been deleted by research team" }, "deletionReason": { "oneOf": [ { "$ref": "#/components/schemas/kyc6.business.v1alpha.BusinessDeletionReason" }, { "type": "null" } ], "title": "deletion_reason", "description": "Reason for deletion if applicable" }, "aliases": { "type": "array", "items": { "$ref": "#/components/schemas/kyc6.business.v1alpha.BusinessAlias" }, "title": "aliases", "description": "List of aliases for the business" }, "addresses": { "type": "array", "items": { "$ref": "#/components/schemas/kyc6.business.v1alpha.BusinessAddress" }, "title": "addresses", "description": "List of the business's addresses" }, "profileImages": { "type": "array", "items": { "type": "string" }, "title": "profile_images", "description": "URLs to profile images" }, "notes": { "type": "array", "items": { "$ref": "#/components/schemas/kyc6.common.v1alpha.Note" }, "title": "notes", "description": "Notes associated with the profile" }, "contactEntries": { "type": "array", "items": { "$ref": "#/components/schemas/kyc6.business.v1alpha.BusinessContactEntry" }, "title": "contact_entries", "description": "Contact entries for the business" }, "businessTypes": { "type": "array", "items": { "$ref": "#/components/schemas/kyc6.business.v1alpha.BusinessType" }, "title": "business_types", "description": "Type of business (e.g., Bank, Privately-Held Company)" }, "activities": { "type": "array", "items": { "type": "string" }, "title": "activities", "description": "List of business activities (e.g., Securities broker, Electric car manufacturer)" }, "identifiers": { "type": "array", "items": { "$ref": "#/components/schemas/kyc6.common.v1alpha.Identifier" }, "title": "identifiers", "description": "Identifiers for the business" }, "evidences": { "type": "array", "items": { "$ref": "#/components/schemas/kyc6.business.v1alpha.BusinessEvidence" }, "title": "evidences", "description": "Evidence supporting the profile" }, "sanEntries": { "title": "san_entries", "description": "Sanction entries", "$ref": "#/components/schemas/kyc6.common.v1alpha.SanctionEntries" }, "relEntries": { "type": "array", "items": { "$ref": "#/components/schemas/kyc6.common.v1alpha.RelEntry" }, "title": "rel_entries", "description": "Regulatory Enforcement List entries" }, "rreEntries": { "type": "array", "items": { "$ref": "#/components/schemas/kyc6.common.v1alpha.RreEntry" }, "title": "rre_entries", "description": "Reputational Risk Exposure entries" }, "poiEntries": { "type": "array", "items": { "$ref": "#/components/schemas/kyc6.common.v1alpha.PoiEntry" }, "title": "poi_entries", "description": "Profile of Interest entries" }, "insEntries": { "type": "array", "items": { "$ref": "#/components/schemas/kyc6.common.v1alpha.InsEntry" }, "title": "ins_entries", "description": "Insolvency entries" }, "individualLinks": { "type": "array", "items": { "$ref": "#/components/schemas/kyc6.business.v1alpha.BusinessLinkedIndividual" }, "title": "individual_links", "description": "Linked individuals" }, "businessLinks": { "type": "array", "items": { "$ref": "#/components/schemas/kyc6.business.v1alpha.BusinessLinkedBusiness" }, "title": "business_links", "description": "Linked businesses" }, "griEntries": { "type": "array", "items": { "$ref": "#/components/schemas/kyc6.common.v1alpha.GriEntry" }, "title": "gri_entries", "description": "Gambling Risk Intelligence entries" }, "soeEntry": { "oneOf": [ { "$ref": "#/components/schemas/kyc6.business.v1alpha.SoeEntry" }, { "type": "null" } ], "title": "soe_entry", "description": "State-Owned Enterprise entry (optional)" }, "datasets": { "type": "array", "items": { "$ref": "#/components/schemas/kyc6.common.v1alpha.BusinessProfileDataset" }, "title": "datasets", "description": "The profile datasets" } }, "title": "BusinessProfile", "additionalProperties": false, "description": "Business profile response from /businesses/{resourceId} endpoint" }, "kyc6.business.v1alpha.BusinessSearchResult": { "type": "object", "properties": { "qrCode": { "type": "string", "title": "qr_code", "description": "The unique Quick Reference code of the business" }, "version": { "type": [ "integer", "string", "null" ], "title": "version", "format": "int64", "description": "The version number can be used by clients to detect when a profile has changed" }, "resourceUri": { "type": "string", "title": "resource_uri", "description": "The resource URI can be used to retrieve the full profile of the business" }, "resourceId": { "type": "string", "title": "resource_id", "description": "The resource ID can be used to retrieve the full profile or the PDF of the business" }, "score": { "type": "integer", "title": "score", "format": "int32", "description": "The match score of the profile (75-100)" }, "match": { "type": "string", "title": "match", "description": "The name of the profile that has been matched in the search" }, "name": { "type": "string", "title": "name", "description": "The primary name of the profile" }, "addresses": { "type": "array", "items": { "$ref": "#/components/schemas/kyc6.common.v1alpha.Address" }, "title": "addresses", "description": "The list of profile addresses and nationalities" }, "countries": { "type": "array", "items": { "type": "string", "deprecated": true }, "title": "countries", "description": "The list of countries from addresses and nationalities (deprecated, use addresses instead)", "deprecated": true }, "datasets": { "type": "array", "items": { "$ref": "#/components/schemas/kyc6.common.v1alpha.BusinessProfileDataset" }, "title": "datasets", "description": "The profile datasets" }, "currentSanBodyIds": { "type": "array", "items": { "type": "integer", "format": "int32" }, "title": "current_san_body_ids", "description": "The list of IDs of all sanctioning bodies currently sanctioning the profile" }, "formerSanBodyIds": { "type": "array", "items": { "type": "integer", "format": "int32" }, "title": "former_san_body_ids", "description": "The list of IDs of all sanctioning bodies that were sanctioning the profile in the past" } }, "title": "BusinessSearchResult", "additionalProperties": false, "description": "Business search result from the /businesses endpoint" }, "kyc6.business.v1alpha.BusinessType": { "type": "string", "title": "BusinessType", "enum": [ "BUSINESS_TYPE_UNSPECIFIED", "BUSINESS_TYPE_VESSEL", "BUSINESS_TYPE_AIRCRAFT", "BUSINESS_TYPE_TERRORIST_ORGANISATION", "BUSINESS_TYPE_ORGANISED_CRIME_GROUP", "BUSINESS_TYPE_MILITANT_GROUP", "BUSINESS_TYPE_SHELL_CORPORATION", "BUSINESS_TYPE_SOVEREIGN_WEALTH_FUND", "BUSINESS_TYPE_GOVERNMENT_BODY", "BUSINESS_TYPE_POLITICAL_PARTY", "BUSINESS_TYPE_CIVIC_MOVEMENT", "BUSINESS_TYPE_INTERNATIONAL_ORGANISATION", "BUSINESS_TYPE_OTHER_INTERNATIONAL_ORGANISATIONS", "BUSINESS_TYPE_NON_GOVERNMENT_ORGANISATION", "BUSINESS_TYPE_CHARITABLE_ORGANISATION", "BUSINESS_TYPE_PROFESSIONAL_ORGANISATION", "BUSINESS_TYPE_PRIVATELY_HELD_COMPANY", "BUSINESS_TYPE_PUBLICLY_TRADED_COMPANY", "BUSINESS_TYPE_TRUST_FUND", "BUSINESS_TYPE_BANK", "BUSINESS_TYPE_CRYPTOCURRENCY_BUSINESS", "BUSINESS_TYPE_GAMING_BUSINESS", "BUSINESS_TYPE_NON_BANK_FINANCIAL_INSTITUTION", "BUSINESS_TYPE_DESIGNATED_PROFESSIONAL_ORGANISATION", "BUSINESS_TYPE_WEBSITE", "BUSINESS_TYPE_FAKE_ENTITY_CLONE_COMPANY", "BUSINESS_TYPE_APPS_APPLICATIONS" ], "description": "Business type enumeration" }, "kyc6.business.v1alpha.ResultAndProfile": { "type": "object", "properties": { "searchResult": { "title": "search_result", "description": "The initial search result", "$ref": "#/components/schemas/kyc6.business.v1alpha.BusinessSearchResult" }, "profile": { "title": "profile", "description": "The profile that matches that result", "$ref": "#/components/schemas/kyc6.business.v1alpha.BusinessProfile" } }, "title": "ResultAndProfile", "additionalProperties": false }, "kyc6.business.v1alpha.SoeEntry": { "type": "object", "properties": { "level": { "title": "level", "$ref": "#/components/schemas/kyc6.business.v1alpha.SoeLevel" }, "status": { "title": "status", "$ref": "#/components/schemas/kyc6.business.v1alpha.SoeStatus" }, "evidenceIds": { "type": "array", "items": { "type": "string" }, "title": "evidence_ids" } }, "title": "SoeEntry", "additionalProperties": false, "description": "State-Owned Enterprise entry (business-only)" }, "kyc6.business.v1alpha.SoeLevel": { "type": "string", "title": "SoeLevel", "enum": [ "SOE_LEVEL_UNSPECIFIED", "SOE_LEVEL_NATIONAL", "SOE_LEVEL_LOCAL" ] }, "kyc6.business.v1alpha.SoeStatus": { "type": "string", "title": "SoeStatus", "enum": [ "SOE_STATUS_UNSPECIFIED", "SOE_STATUS_CURRENT", "SOE_STATUS_FORMER" ] }, "kyc6.common.v1alpha.Address": { "type": "object", "properties": { "geography": { "type": "string", "title": "geography" }, "city": { "type": [ "string", "null" ], "title": "city" } }, "title": "Address", "additionalProperties": false, "description": "Address information for search results" }, "kyc6.common.v1alpha.BusinessProfileDataset": { "type": "string", "title": "BusinessProfileDataset", "enum": [ "BUSINESS_PROFILE_DATASET_UNSPECIFIED", "BUSINESS_PROFILE_DATASET_PEP_LINKED", "BUSINESS_PROFILE_DATASET_SAN_CURRENT", "BUSINESS_PROFILE_DATASET_SAN_FORMER", "BUSINESS_PROFILE_DATASET_INS", "BUSINESS_PROFILE_DATASET_RRE", "BUSINESS_PROFILE_DATASET_POI", "BUSINESS_PROFILE_DATASET_REL", "BUSINESS_PROFILE_DATASET_SOE_CURRENT", "BUSINESS_PROFILE_DATASET_SOE_FORMER", "BUSINESS_PROFILE_DATASET_GRI", "BUSINESS_PROFILE_DATASET_PEP", "BUSINESS_PROFILE_DATASET_SAN" ], "description": "Business profile datasets (which datasets the profile belongs to)" }, "kyc6.common.v1alpha.EvidenceCredibility": { "type": "string", "title": "EvidenceCredibility", "enum": [ "EVIDENCE_CREDIBILITY_UNSPECIFIED", "EVIDENCE_CREDIBILITY_LOW", "EVIDENCE_CREDIBILITY_MEDIUM", "EVIDENCE_CREDIBILITY_HIGH" ] }, "kyc6.common.v1alpha.GriEntry": { "type": "object", "properties": { "evidenceId": { "type": "string", "title": "evidence_id" }, "title": { "type": "string", "title": "title" }, "summary": { "type": "string", "title": "summary" }, "keywords": { "type": "string", "title": "keywords" } }, "title": "GriEntry", "additionalProperties": false, "description": "Gambling Risk Intelligence entry information" }, "kyc6.common.v1alpha.Identifier": { "type": "object", "properties": { "category": { "type": "string", "title": "category" }, "value": { "type": "string", "title": "value" } }, "title": "Identifier", "additionalProperties": false, "description": "Identifier information" }, "kyc6.common.v1alpha.IndividualProfileDataset": { "type": "string", "title": "IndividualProfileDataset", "enum": [ "INDIVIDUAL_PROFILE_DATASET_UNSPECIFIED", "INDIVIDUAL_PROFILE_DATASET_PEP_CURRENT", "INDIVIDUAL_PROFILE_DATASET_PEP_FORMER", "INDIVIDUAL_PROFILE_DATASET_PEP_LINKED", "INDIVIDUAL_PROFILE_DATASET_SAN_CURRENT", "INDIVIDUAL_PROFILE_DATASET_SAN_FORMER", "INDIVIDUAL_PROFILE_DATASET_INS", "INDIVIDUAL_PROFILE_DATASET_RRE", "INDIVIDUAL_PROFILE_DATASET_DD", "INDIVIDUAL_PROFILE_DATASET_POI", "INDIVIDUAL_PROFILE_DATASET_REL", "INDIVIDUAL_PROFILE_DATASET_GRI" ], "description": "Individual profile datasets" }, "kyc6.common.v1alpha.InsEntry": { "type": "object", "properties": { "type": { "type": "string", "title": "type" }, "insolvencyIdNumber": { "type": [ "string", "null" ], "title": "insolvency_id_number" }, "solicitor": { "type": [ "string", "null" ], "title": "solicitor" }, "court": { "type": [ "string", "null" ], "title": "court" }, "petitioner": { "type": [ "string", "null" ], "title": "petitioner" }, "debt": { "type": [ "string", "null" ], "title": "debt" }, "accountantInBankruptcyCaseNumber": { "type": [ "string", "null" ], "title": "accountant_in_bankruptcy_case_number" }, "insolvencyStartDateIso": { "type": [ "string", "null" ], "title": "insolvency_start_date_iso" }, "insolvencyEndDateIso": { "type": [ "string", "null" ], "title": "insolvency_end_date_iso" }, "hearingDateIso": { "type": [ "string", "null" ], "title": "hearing_date_iso" }, "presentedDateOfPetitionIso": { "type": [ "string", "null" ], "title": "presented_date_of_petition_iso" }, "gazetteIssueDateIso": { "type": [ "string", "null" ], "title": "gazette_issue_date_iso" }, "awardDateIso": { "type": [ "string", "null" ], "title": "award_date_iso" }, "firstOrderDateIso": { "type": [ "string", "null" ], "title": "first_order_date_iso" }, "evidenceIds": { "type": "array", "items": { "type": "string" }, "title": "evidence_ids" } }, "title": "InsEntry", "additionalProperties": false, "description": "Insolvency entry information" }, "kyc6.common.v1alpha.Note": { "type": "object", "properties": { "value": { "type": "string", "title": "value" } }, "title": "Note", "additionalProperties": false, "description": "Note information (shared by individual and business profiles)" }, "kyc6.common.v1alpha.PoiEntry": { "type": "object", "properties": { "category": { "type": "string", "title": "category" }, "evidenceIds": { "type": "array", "items": { "type": "string" }, "title": "evidence_ids" }, "positions": { "type": "array", "items": { "$ref": "#/components/schemas/kyc6.common.v1alpha.PoiPosition" }, "title": "positions" } }, "title": "PoiEntry", "additionalProperties": false, "description": "Profile of Interest entry information" }, "kyc6.common.v1alpha.PoiPosition": { "type": "object", "properties": { "position": { "type": "string", "title": "position" }, "segment": { "type": [ "string", "null" ], "title": "segment" }, "countryIsoCode": { "type": [ "string", "null" ], "title": "country_iso_code" }, "dateFromIso": { "type": [ "string", "null" ], "title": "date_from_iso" }, "dateToIso": { "type": [ "string", "null" ], "title": "date_to_iso" } }, "title": "PoiPosition", "additionalProperties": false, "description": "POI position information" }, "kyc6.common.v1alpha.RelCategory": { "type": "string", "title": "RelCategory", "enum": [ "REL_CATEGORY_UNSPECIFIED", "REL_CATEGORY_FINANCIAL_REGULATOR", "REL_CATEGORY_LAW_ENFORCEMENT" ] }, "kyc6.common.v1alpha.RelEntry": { "type": "object", "properties": { "category": { "title": "category", "$ref": "#/components/schemas/kyc6.common.v1alpha.RelCategory" }, "subcategory": { "type": "string", "title": "subcategory" }, "events": { "type": "array", "items": { "$ref": "#/components/schemas/kyc6.common.v1alpha.RelEvent" }, "title": "events" } }, "title": "RelEntry", "additionalProperties": false, "description": "Regulatory Enforcement List entry information" }, "kyc6.common.v1alpha.RelEvent": { "type": "object", "properties": { "type": { "type": "string", "title": "type" }, "currencyCode": { "type": [ "string", "null" ], "title": "currency_code" }, "amount": { "type": [ "integer", "null" ], "title": "amount", "format": "int32" }, "period": { "oneOf": [ { "$ref": "#/components/schemas/kyc6.common.v1alpha.RelPeriod" }, { "type": "null" } ], "title": "period" }, "dateIso": { "type": [ "string", "null" ], "title": "date_iso" }, "evidenceIds": { "type": "array", "items": { "type": "string" }, "title": "evidence_ids" } }, "title": "RelEvent", "additionalProperties": false, "description": "REL event information" }, "kyc6.common.v1alpha.RelPeriod": { "type": "object", "properties": { "days": { "type": [ "integer", "null" ], "title": "days", "format": "int32" }, "months": { "type": [ "integer", "null" ], "title": "months", "format": "int32" }, "years": { "type": [ "integer", "null" ], "title": "years", "format": "int32" } }, "title": "RelPeriod", "additionalProperties": false, "description": "Time period information for REL events" }, "kyc6.common.v1alpha.RreEntry": { "type": "object", "properties": { "category": { "type": "string", "title": "category" }, "subcategory": { "type": [ "string", "null" ], "title": "subcategory" }, "events": { "type": "array", "items": { "$ref": "#/components/schemas/kyc6.common.v1alpha.RreEvent" }, "title": "events" } }, "title": "RreEntry", "additionalProperties": false, "description": "Reputational Risk Exposure entry information" }, "kyc6.common.v1alpha.RreEvent": { "type": "object", "properties": { "type": { "type": "string", "title": "type" }, "dateIso": { "type": [ "string", "null" ], "title": "date_iso" }, "evidenceIds": { "type": "array", "items": { "type": "string" }, "title": "evidence_ids" } }, "title": "RreEvent", "additionalProperties": false, "description": "RRE event information" }, "kyc6.common.v1alpha.SanctionEntries": { "type": "object", "properties": { "current": { "type": "array", "items": { "$ref": "#/components/schemas/kyc6.common.v1alpha.SanctionEntry" }, "title": "current" }, "former": { "type": "array", "items": { "$ref": "#/components/schemas/kyc6.common.v1alpha.SanctionEntry" }, "title": "former" } }, "title": "SanctionEntries", "additionalProperties": false, "description": "Sanction entries container" }, "kyc6.common.v1alpha.SanctionEntry": { "type": "object", "properties": { "sanctionId": { "type": [ "string", "null" ], "title": "sanction_id" }, "measures": { "type": "array", "items": { "type": "string" }, "title": "measures" }, "regime": { "title": "regime", "$ref": "#/components/schemas/kyc6.common.v1alpha.SanctionRegime" }, "events": { "type": "array", "items": { "$ref": "#/components/schemas/kyc6.common.v1alpha.SanctionEvent" }, "title": "events" } }, "title": "SanctionEntry", "additionalProperties": false, "description": "Sanction entry information" }, "kyc6.common.v1alpha.SanctionEvent": { "type": "object", "properties": { "type": { "title": "type", "$ref": "#/components/schemas/kyc6.common.v1alpha.SanctionEventType" }, "dateIso": { "type": "string", "title": "date_iso" }, "evidenceIds": { "type": "array", "items": { "type": "string" }, "title": "evidence_ids" } }, "title": "SanctionEvent", "additionalProperties": false, "description": "Sanction event information" }, "kyc6.common.v1alpha.SanctionEventType": { "type": "string", "title": "SanctionEventType", "enum": [ "SANCTION_EVENT_TYPE_UNSPECIFIED", "SANCTION_EVENT_TYPE_ADDED", "SANCTION_EVENT_TYPE_AMENDED", "SANCTION_EVENT_TYPE_REMOVED" ] }, "kyc6.common.v1alpha.SanctionRegime": { "type": "object", "properties": { "body": { "type": "string", "title": "body" }, "bodyId": { "type": [ "integer", "null" ], "title": "body_id", "format": "int32" }, "name": { "type": [ "string", "null" ], "title": "name" }, "origin": { "type": "string", "title": "origin" }, "types": { "type": "array", "items": { "$ref": "#/components/schemas/kyc6.common.v1alpha.SanctionType" }, "title": "types" } }, "title": "SanctionRegime", "additionalProperties": false, "description": "Sanction regime information" }, "kyc6.common.v1alpha.SanctionType": { "type": "string", "title": "SanctionType", "enum": [ "SANCTION_TYPE_UNSPECIFIED", "SANCTION_TYPE_COUNTER_NARCOTICS", "SANCTION_TYPE_HOSTILE_ACTIVITIES", "SANCTION_TYPE_HUMAN_RIGHTS", "SANCTION_TYPE_NON_PROLIFERATION", "SANCTION_TYPE_TERRITORIAL_VIOLATION", "SANCTION_TYPE_TERRORISM" ] }, "kyc6.individual.v1alpha.ActivityLog": { "type": "object", "properties": { "matches": { "type": "array", "items": { "$ref": "#/components/schemas/kyc6.individual.v1alpha.ResultAndProfile" }, "title": "matches", "description": "string should be the kyc6 resource id" } }, "title": "ActivityLog", "additionalProperties": false }, "kyc6.individual.v1alpha.Alias": { "type": "object", "properties": { "firstName": { "type": [ "string", "null" ], "title": "first_name" }, "middleName": { "type": [ "string", "null" ], "title": "middle_name" }, "lastName": { "type": [ "string", "null" ], "title": "last_name" }, "type": { "title": "type", "$ref": "#/components/schemas/kyc6.individual.v1alpha.AliasType" } }, "title": "Alias", "additionalProperties": false, "description": "Alias information" }, "kyc6.individual.v1alpha.AliasType": { "type": "string", "title": "AliasType", "enum": [ "ALIAS_TYPE_UNSPECIFIED", "ALIAS_TYPE_ORIGINAL_SCRIPT_NAME", "ALIAS_TYPE_NAME_SPELLING_VARIATION", "ALIAS_TYPE_SHORTENED_NAME", "ALIAS_TYPE_MAIDEN_NAME", "ALIAS_TYPE_NICKNAME", "ALIAS_TYPE_PREVIOUS_NAME", "ALIAS_TYPE_FAKE_NAME" ] }, "kyc6.individual.v1alpha.DdEntry": { "type": "object", "properties": { "caseReference": { "type": [ "string", "null" ], "title": "case_reference" }, "reason": { "type": "string", "title": "reason" }, "conduct": { "type": [ "string", "null" ], "title": "conduct" }, "dateFromIso": { "type": [ "string", "null" ], "title": "date_from_iso" }, "dateToIso": { "type": [ "string", "null" ], "title": "date_to_iso" }, "evidenceIds": { "type": "array", "items": { "type": "string" }, "title": "evidence_ids" } }, "title": "DdEntry", "additionalProperties": false, "description": "Disqualified Director entry information" }, "kyc6.individual.v1alpha.DeletionReason": { "type": "object", "properties": { "reason": { "title": "reason", "$ref": "#/components/schemas/kyc6.individual.v1alpha.DeletionReasonType" }, "otherReason": { "type": [ "string", "null" ], "title": "other_reason", "description": "Populated when reason is \"Other\"" } }, "title": "DeletionReason", "additionalProperties": false, "description": "Deletion reason information" }, "kyc6.individual.v1alpha.DeletionReasonType": { "type": "string", "title": "DeletionReasonType", "enum": [ "DELETION_REASON_TYPE_UNSPECIFIED", "DELETION_REASON_TYPE_GOVERNMENT_POSITION_OUT_OF_SCOPE", "DELETION_REASON_TYPE_ADVERSE_MEDIA_CATEGORY_OUT_OF_SCOPE", "DELETION_REASON_TYPE_DUPLICATE_PROFILE", "DELETION_REASON_TYPE_REDUNDANT_PROFILE", "DELETION_REASON_TYPE_EXPIRED_RISK_RELEVANCE", "DELETION_REASON_TYPE_OTHER" ] }, "kyc6.individual.v1alpha.Evidence": { "type": "object", "properties": { "evidenceId": { "type": "string", "title": "evidence_id" }, "originalUrl": { "type": "string", "title": "original_url" }, "isCopyrighted": { "type": "boolean", "title": "is_copyrighted" }, "title": { "type": [ "string", "null" ], "title": "title" }, "credibility": { "oneOf": [ { "$ref": "#/components/schemas/kyc6.common.v1alpha.EvidenceCredibility" }, { "type": "null" } ], "title": "credibility" }, "language": { "type": [ "string", "null" ], "title": "language" }, "summary": { "type": [ "string", "null" ], "title": "summary" }, "keywords": { "type": [ "string", "null" ], "title": "keywords" }, "captureDateIso": { "type": [ "string", "null" ], "title": "capture_date_iso" }, "publicationDateIso": { "type": [ "string", "null" ], "title": "publication_date_iso" }, "assetUrl": { "type": [ "string", "null" ], "title": "asset_url" }, "datasets": { "type": "array", "items": { "$ref": "#/components/schemas/kyc6.common.v1alpha.IndividualProfileDataset" }, "title": "datasets" } }, "title": "Evidence", "additionalProperties": false, "description": "Evidence information" }, "kyc6.individual.v1alpha.Gender": { "type": "string", "title": "Gender", "enum": [ "GENDER_UNSPECIFIED", "GENDER_MALE", "GENDER_FEMALE" ], "description": "Gender enumeration" }, "kyc6.individual.v1alpha.IndividualAddress": { "type": "object", "properties": { "addressType": { "title": "address_type", "$ref": "#/components/schemas/kyc6.individual.v1alpha.IndividualAddressType" }, "line1": { "type": [ "string", "null" ], "title": "line1" }, "line2": { "type": [ "string", "null" ], "title": "line2" }, "postcode": { "type": [ "string", "null" ], "title": "postcode" }, "city": { "type": [ "string", "null" ], "title": "city" }, "county": { "type": [ "string", "null" ], "title": "county" }, "countyAbbrev": { "type": [ "string", "null" ], "title": "county_abbrev" }, "countryIsoCode": { "type": "string", "title": "country_iso_code" } }, "title": "IndividualAddress", "additionalProperties": false, "description": "Individual address information" }, "kyc6.individual.v1alpha.IndividualAddressType": { "type": "string", "title": "IndividualAddressType", "enum": [ "INDIVIDUAL_ADDRESS_TYPE_UNSPECIFIED", "INDIVIDUAL_ADDRESS_TYPE_PLACE_OF_BIRTH", "INDIVIDUAL_ADDRESS_TYPE_RESIDENTIAL", "INDIVIDUAL_ADDRESS_TYPE_BUSINESS", "INDIVIDUAL_ADDRESS_TYPE_PREVIOUS_RESIDENTIAL", "INDIVIDUAL_ADDRESS_TYPE_PREVIOUS_BUSINESS" ] }, "kyc6.individual.v1alpha.IndividualContactEntry": { "type": "object", "properties": { "category": { "title": "category", "$ref": "#/components/schemas/kyc6.individual.v1alpha.IndividualContactEntryCategory" }, "value": { "type": "string", "title": "value" } }, "title": "IndividualContactEntry", "additionalProperties": false, "description": "Individual contact entry (Telephone, Fax, Mobile, Email)" }, "kyc6.individual.v1alpha.IndividualContactEntryCategory": { "type": "string", "title": "IndividualContactEntryCategory", "enum": [ "INDIVIDUAL_CONTACT_ENTRY_CATEGORY_UNSPECIFIED", "INDIVIDUAL_CONTACT_ENTRY_CATEGORY_TELEPHONE", "INDIVIDUAL_CONTACT_ENTRY_CATEGORY_FAX", "INDIVIDUAL_CONTACT_ENTRY_CATEGORY_MOBILE", "INDIVIDUAL_CONTACT_ENTRY_CATEGORY_EMAIL" ], "description": "Individual contact entry category" }, "kyc6.individual.v1alpha.IndividualProfile": { "type": "object", "properties": { "qrCode": { "type": "string", "title": "qr_code", "description": "The unique Quick Reference code of the individual" }, "version": { "type": [ "integer", "string" ], "title": "version", "format": "int64", "description": "The version number can be used by clients to detect when a profile has changed" }, "resourceUri": { "type": "string", "title": "resource_uri", "description": "The resource URI can be used to query the API to retrieve the profile" }, "resourceId": { "type": "string", "title": "resource_id", "description": "The resource ID can be used to retrieve the full profile or the PDF" }, "firstName": { "type": [ "string", "null" ], "title": "first_name", "description": "The first name of the individual" }, "middleName": { "type": [ "string", "null" ], "title": "middle_name", "description": "The middle name of the individual" }, "lastName": { "type": "string", "title": "last_name", "description": "The last name of the individual" }, "gender": { "oneOf": [ { "$ref": "#/components/schemas/kyc6.individual.v1alpha.Gender" }, { "type": "null" } ], "title": "gender", "description": "The gender of the individual" }, "isDeleted": { "type": "boolean", "title": "is_deleted", "description": "Indicates if the individual has been deleted by research team" }, "deletionReason": { "oneOf": [ { "$ref": "#/components/schemas/kyc6.individual.v1alpha.DeletionReason" }, { "type": "null" } ], "title": "deletion_reason", "description": "Reason for deletion if applicable" }, "isDeceased": { "type": "boolean", "title": "is_deceased", "description": "Indicates if the individual is deceased" }, "aliases": { "type": "array", "items": { "$ref": "#/components/schemas/kyc6.individual.v1alpha.Alias" }, "title": "aliases", "description": "List of aliases for the individual" }, "datesOfBirthIso": { "type": "array", "items": { "type": "string" }, "title": "dates_of_birth_iso", "description": "List of birth dates for the individual" }, "datesOfDeathIso": { "type": "array", "items": { "type": "string" }, "title": "dates_of_death_iso", "description": "List of death dates for the individual" }, "nationalitiesIsoCodes": { "type": "array", "items": { "type": "string" }, "title": "nationalities_iso_codes", "description": "List of the individual's nationalities (ISO country codes)" }, "addresses": { "type": "array", "items": { "$ref": "#/components/schemas/kyc6.individual.v1alpha.IndividualAddress" }, "title": "addresses", "description": "List of the individual's addresses" }, "profileImages": { "type": "array", "items": { "type": "string" }, "title": "profile_images", "description": "URLs to profile images" }, "notes": { "type": "array", "items": { "$ref": "#/components/schemas/kyc6.common.v1alpha.Note" }, "title": "notes", "description": "Notes associated with the profile" }, "contactEntries": { "type": "array", "items": { "$ref": "#/components/schemas/kyc6.individual.v1alpha.IndividualContactEntry" }, "title": "contact_entries", "description": "Contact entries for the individual" }, "identifiers": { "type": "array", "items": { "$ref": "#/components/schemas/kyc6.common.v1alpha.Identifier" }, "title": "identifiers", "description": "Identifiers for the individual" }, "evidences": { "type": "array", "items": { "$ref": "#/components/schemas/kyc6.individual.v1alpha.Evidence" }, "title": "evidences", "description": "Evidence supporting the profile" }, "sanEntries": { "title": "san_entries", "description": "Sanction entries", "$ref": "#/components/schemas/kyc6.common.v1alpha.SanctionEntries" }, "relEntries": { "type": "array", "items": { "$ref": "#/components/schemas/kyc6.common.v1alpha.RelEntry" }, "title": "rel_entries", "description": "Regulatory Enforcement List entries" }, "rreEntries": { "type": "array", "items": { "$ref": "#/components/schemas/kyc6.common.v1alpha.RreEntry" }, "title": "rre_entries", "description": "Reputational Risk Exposure entries" }, "poiEntries": { "type": "array", "items": { "$ref": "#/components/schemas/kyc6.common.v1alpha.PoiEntry" }, "title": "poi_entries", "description": "Profile of Interest entries" }, "insEntries": { "type": "array", "items": { "$ref": "#/components/schemas/kyc6.common.v1alpha.InsEntry" }, "title": "ins_entries", "description": "Insolvency entries" }, "ddEntries": { "type": "array", "items": { "$ref": "#/components/schemas/kyc6.individual.v1alpha.DdEntry" }, "title": "dd_entries", "description": "Disqualified Director entries" }, "pepEntries": { "title": "pep_entries", "description": "PEP entries", "$ref": "#/components/schemas/kyc6.individual.v1alpha.PepEntries" }, "pepByAssociationEntries": { "type": "array", "items": { "$ref": "#/components/schemas/kyc6.individual.v1alpha.PepAssociationEntry" }, "title": "pep_by_association_entries", "description": "PEP by association entries" }, "individualLinks": { "type": "array", "items": { "$ref": "#/components/schemas/kyc6.individual.v1alpha.LinkedIndividual" }, "title": "individual_links", "description": "Linked individuals" }, "businessLinks": { "type": "array", "items": { "$ref": "#/components/schemas/kyc6.individual.v1alpha.LinkedBusiness" }, "title": "business_links", "description": "Linked businesses" }, "griEntries": { "type": "array", "items": { "$ref": "#/components/schemas/kyc6.common.v1alpha.GriEntry" }, "title": "gri_entries", "description": "Gambling Risk Intelligence entries" }, "datasets": { "type": "array", "items": { "$ref": "#/components/schemas/kyc6.common.v1alpha.IndividualProfileDataset" }, "title": "datasets", "description": "The profile datasets" } }, "title": "IndividualProfile", "additionalProperties": false, "description": "Individual profile response from /individuals/{resourceId} endpoint" }, "kyc6.individual.v1alpha.IndividualSearchResult": { "type": "object", "properties": { "qrCode": { "type": "string", "title": "qr_code", "description": "The unique Quick Reference code of the individual" }, "version": { "type": [ "integer", "string", "null" ], "title": "version", "format": "int64", "description": "The version number can be used by clients to detect when a profile has changed" }, "resourceUri": { "type": "string", "title": "resource_uri", "description": "The resource URI can be used to retrieve the full profile of the individual" }, "resourceId": { "type": "string", "title": "resource_id", "description": "The resource ID can be used to retrieve the full profile or the PDF of the Individual" }, "score": { "type": "integer", "title": "score", "format": "int32", "description": "The match score of the profile (75-100)" }, "match": { "type": "string", "title": "match", "description": "The name of the profile that has been matched in the search" }, "name": { "type": "string", "title": "name", "description": "The primary name of the profile" }, "addresses": { "type": "array", "items": { "$ref": "#/components/schemas/kyc6.common.v1alpha.Address" }, "title": "addresses", "description": "The list of profile addresses and nationalities" }, "countries": { "type": "array", "items": { "type": "string", "deprecated": true }, "title": "countries", "description": "The list of countries from addresses and nationalities (deprecated, use addresses instead)", "deprecated": true }, "datesOfBirth": { "type": "array", "items": { "type": "string" }, "title": "dates_of_birth", "description": "Date of birth entries" }, "gender": { "oneOf": [ { "$ref": "#/components/schemas/kyc6.individual.v1alpha.Gender" }, { "type": "null" } ], "title": "gender", "description": "Gender (for individuals), if known" }, "profileImage": { "type": [ "string", "null" ], "title": "profile_image", "description": "The primary profile image URL" }, "datasets": { "type": "array", "items": { "$ref": "#/components/schemas/kyc6.common.v1alpha.IndividualProfileDataset" }, "title": "datasets", "description": "The profile datasets" }, "currentSanBodyIds": { "type": "array", "items": { "type": "integer", "format": "int32" }, "title": "current_san_body_ids", "description": "The list of IDs of all sanctioning bodies currently sanctioning the profile" }, "formerSanBodyIds": { "type": "array", "items": { "type": "integer", "format": "int32" }, "title": "former_san_body_ids", "description": "The list of IDs of all sanctioning bodies that were sanctioning the profile in the past" }, "pepTier": { "oneOf": [ { "$ref": "#/components/schemas/kyc6.individual.v1alpha.PepTier" }, { "type": "null" } ], "title": "pep_tier", "description": "PEP tier level if applicable" } }, "title": "IndividualSearchResult", "additionalProperties": false, "description": "Individual search result from the /individuals endpoint" }, "kyc6.individual.v1alpha.LinkedBusiness": { "type": "object", "properties": { "qrCode": { "type": "string", "title": "qr_code" }, "name": { "type": "string", "title": "name" }, "resourceUri": { "type": "string", "title": "resource_uri" }, "resourceId": { "type": "string", "title": "resource_id" }, "relationship": { "type": "string", "title": "relationship" }, "ownershipPercentage": { "type": [ "integer", "null" ], "title": "ownership_percentage", "format": "int32" }, "datasets": { "type": "array", "items": { "$ref": "#/components/schemas/kyc6.common.v1alpha.BusinessProfileDataset" }, "title": "datasets" }, "individualLinks": { "type": "array", "items": { "$ref": "#/components/schemas/kyc6.individual.v1alpha.LinkedIndividual" }, "title": "individual_links" } }, "title": "LinkedBusiness", "additionalProperties": false, "description": "Linked business information" }, "kyc6.individual.v1alpha.LinkedIndividual": { "type": "object", "properties": { "qrCode": { "type": "string", "title": "qr_code" }, "firstName": { "type": [ "string", "null" ], "title": "first_name" }, "middleName": { "type": [ "string", "null" ], "title": "middle_name" }, "lastName": { "type": "string", "title": "last_name" }, "relationship": { "type": "string", "title": "relationship" }, "ownershipPercentage": { "type": [ "integer", "null" ], "title": "ownership_percentage", "format": "int32" }, "resourceUri": { "type": "string", "title": "resource_uri" }, "resourceId": { "type": "string", "title": "resource_id" }, "datasets": { "type": "array", "items": { "$ref": "#/components/schemas/kyc6.common.v1alpha.IndividualProfileDataset" }, "title": "datasets" } }, "title": "LinkedIndividual", "additionalProperties": false, "description": "Linked individual information" }, "kyc6.individual.v1alpha.PepAssociationEntry": { "type": "object", "properties": { "qrCode": { "type": "string", "title": "qr_code" }, "resourceUri": { "type": "string", "title": "resource_uri" }, "resourceId": { "type": "string", "title": "resource_id" }, "evidenceIds": { "type": "array", "items": { "type": "string" }, "title": "evidence_ids" } }, "title": "PepAssociationEntry", "additionalProperties": false, "description": "PEP by association entry information" }, "kyc6.individual.v1alpha.PepEntries": { "type": "object", "properties": { "pepTier": { "oneOf": [ { "$ref": "#/components/schemas/kyc6.individual.v1alpha.PepTier" }, { "type": "null" } ], "title": "pep_tier" }, "current": { "type": "array", "items": { "$ref": "#/components/schemas/kyc6.individual.v1alpha.PepEntry" }, "title": "current" }, "former": { "type": "array", "items": { "$ref": "#/components/schemas/kyc6.individual.v1alpha.PepEntry" }, "title": "former" } }, "title": "PepEntries", "additionalProperties": false, "description": "PEP entries container" }, "kyc6.individual.v1alpha.PepEntry": { "type": "object", "properties": { "countryIsoCode": { "type": "string", "title": "country_iso_code" }, "segment": { "type": [ "string", "null" ], "title": "segment" }, "position": { "type": "string", "title": "position" }, "dateFromIso": { "type": [ "string", "null" ], "title": "date_from_iso" }, "dateToIso": { "type": [ "string", "null" ], "title": "date_to_iso" }, "evidenceIds": { "type": "array", "items": { "type": "string" }, "title": "evidence_ids" } }, "title": "PepEntry", "additionalProperties": false, "description": "PEP entry information" }, "kyc6.individual.v1alpha.PepTier": { "type": "string", "title": "PepTier", "enum": [ "PEP_TIER_UNSPECIFIED", "PEP_TIER_1", "PEP_TIER_2", "PEP_TIER_3", "PEP_TIER_BY_ASSOCIATION" ], "description": "PEP tier levels" }, "kyc6.individual.v1alpha.ResultAndProfile": { "type": "object", "properties": { "searchResult": { "title": "search_result", "description": "The initial search result", "$ref": "#/components/schemas/kyc6.individual.v1alpha.IndividualSearchResult" }, "profile": { "title": "profile", "description": "The profile that matches that result", "$ref": "#/components/schemas/kyc6.individual.v1alpha.IndividualProfile" } }, "title": "ResultAndProfile", "additionalProperties": false }, "rapidid.api.aml.v1alpha.ActivityLog": { "type": "object", "properties": { "result": { "title": "result", "description": "The result data to store", "$ref": "#/components/schemas/rapidid.api.aml.v1alpha.PepSanctionsResponse" }, "request": { "title": "request", "description": "The initial request that was used", "$ref": "#/components/schemas/rapidid.api.aml.v1alpha.PepSanctionsRequest" } }, "title": "ActivityLog", "additionalProperties": false }, "rapidid.api.aml.v1alpha.PepSanctionsRequest": { "type": "object", "properties": { "fuzziness": { "type": [ "number", "null" ], "title": "fuzziness", "format": "float", "description": "Search fuzziness level" }, "searchName": { "oneOf": [ { "$ref": "#/components/schemas/rapidid.api.aml.v1alpha.PepSanctionsRequest.SearchName" }, { "type": "null" } ], "title": "search_name" }, "searchQuery": { "type": [ "string", "null" ], "title": "search_query", "description": "Name of person to search for" }, "birthYear": { "type": [ "string", "null" ], "title": "birth_year", "description": "Birth year of person in YYYY format" }, "exactMatch": { "type": [ "boolean", "null" ], "title": "exact_match", "description": "Exact match disables all standard and optional matching behaviours" }, "countryCodes": { "type": "array", "items": { "type": "string" }, "title": "country_codes", "description": "Results are filtered by entity nationality or country of residence (ISO 3166-1 alpha-2)" } }, "title": "PepSanctionsRequest", "additionalProperties": false, "description": "PEP sanctions request" }, "rapidid.api.aml.v1alpha.PepSanctionsRequest.SearchName": { "type": "object", "properties": { "firstName": { "type": "string", "title": "first_name" }, "middleNames": { "type": [ "string", "null" ], "title": "middle_names" }, "lastName": { "type": "string", "title": "last_name" } }, "title": "SearchName", "additionalProperties": false, "description": "Structured name search (overridden by search_query if present)" }, "rapidid.api.aml.v1alpha.PepSanctionsResponse": { "type": "object", "properties": { "matchStatus": { "title": "match_status", "description": "Main response data", "$ref": "#/components/schemas/rapidid.api.aml.v1alpha.PepSanctionsResponse.MatchStatus" }, "totalHits": { "type": [ "integer", "string" ], "title": "total_hits", "format": "int64" }, "hits": { "type": "array", "items": { "$ref": "#/components/schemas/rapidid.api.aml.v1alpha.PepSanctionsResponse.Hit" }, "title": "hits" }, "error": { "oneOf": [ { "$ref": "#/components/schemas/rapidid.api.aml.v1alpha.PepSanctionsResponse.Error" }, { "type": "null" } ], "title": "error" }, "blacklistHits": { "type": "array", "items": { "$ref": "#/components/schemas/rapidid.api.aml.v1alpha.PepSanctionsResponse.Hit" }, "title": "blacklist_hits" }, "id": { "type": [ "integer", "string" ], "title": "id", "format": "int64" }, "ref": { "type": "string", "title": "ref" }, "searcherId": { "type": [ "integer", "string" ], "title": "searcher_id", "format": "int64" }, "assigneeId": { "type": [ "integer", "string" ], "title": "assignee_id", "format": "int64" }, "filters": { "title": "filters", "$ref": "#/components/schemas/rapidid.api.aml.v1alpha.PepSanctionsResponse.Filters" }, "riskLevel": { "type": [ "string", "null" ], "title": "risk_level" }, "searchTerm": { "type": "string", "title": "search_term" }, "submittedTerm": { "type": "string", "title": "submitted_term" }, "clientRef": { "type": "string", "title": "client_ref" }, "totalMatches": { "type": [ "integer", "string" ], "title": "total_matches", "format": "int64" }, "totalBlacklistHits": { "type": [ "integer", "string" ], "title": "total_blacklist_hits", "format": "int64" }, "createdAt": { "type": "string", "title": "created_at" }, "updatedAt": { "type": "string", "title": "updated_at" }, "tags": { "type": "array", "items": { "type": "string" }, "title": "tags" }, "labels": { "type": "array", "items": { "type": "string" }, "title": "labels" }, "limit": { "type": "integer", "title": "limit", "format": "int32" }, "offset": { "type": "integer", "title": "offset", "format": "int32" }, "searcher": { "title": "searcher", "$ref": "#/components/schemas/rapidid.api.aml.v1alpha.PepSanctionsResponse.User" }, "assignee": { "title": "assignee", "$ref": "#/components/schemas/rapidid.api.aml.v1alpha.PepSanctionsResponse.User" }, "code": { "type": [ "integer", "null" ], "title": "code", "format": "int32", "description": "Top-level response metadata" }, "status": { "type": [ "string", "null" ], "title": "status" }, "rapidId": { "type": [ "string", "null" ], "title": "rapid_id" } }, "title": "PepSanctionsResponse", "additionalProperties": false, "description": "PEP sanctions response" }, "rapidid.api.aml.v1alpha.PepSanctionsResponse.Aka": { "type": "object", "properties": { "name": { "type": "string", "title": "name" } }, "title": "Aka", "additionalProperties": false, "description": "AKA (also known as) information" }, "rapidid.api.aml.v1alpha.PepSanctionsResponse.Associate": { "type": "object", "properties": { "association": { "type": "string", "title": "association", "description": "parent, child, spouse, sibling, etc." }, "name": { "type": "string", "title": "name" } }, "title": "Associate", "additionalProperties": false, "description": "Associated person information" }, "rapidid.api.aml.v1alpha.PepSanctionsResponse.Document": { "type": "object", "properties": { "id": { "type": "string", "title": "id" }, "name": { "type": "string", "title": "name" }, "entityType": { "type": "string", "title": "entity_type" }, "aka": { "type": "array", "items": { "$ref": "#/components/schemas/rapidid.api.aml.v1alpha.PepSanctionsResponse.Aka" }, "title": "aka" }, "associates": { "type": "array", "items": { "$ref": "#/components/schemas/rapidid.api.aml.v1alpha.PepSanctionsResponse.Associate" }, "title": "associates" }, "fields": { "type": "array", "items": { "$ref": "#/components/schemas/rapidid.api.aml.v1alpha.PepSanctionsResponse.Field" }, "title": "fields" }, "keywords": { "type": "array", "items": { "type": "string" }, "title": "keywords" }, "lastUpdatedUtc": { "type": "string", "title": "last_updated_utc" }, "createdUtc": { "type": [ "string", "null" ], "title": "created_utc" }, "media": { "type": "array", "items": { "$ref": "#/components/schemas/rapidid.api.aml.v1alpha.PepSanctionsResponse.Media" }, "title": "media" }, "sourceNotes": { "type": "object", "title": "source_notes", "additionalProperties": { "title": "value", "$ref": "#/components/schemas/rapidid.api.aml.v1alpha.PepSanctionsResponse.SourceNote" } }, "types": { "type": "array", "items": { "type": "string" }, "title": "types" } }, "title": "Document", "additionalProperties": false, "description": "Document information" }, "rapidid.api.aml.v1alpha.PepSanctionsResponse.Document.SourceNotesEntry": { "type": "object", "properties": { "key": { "type": "string", "title": "key" }, "value": { "title": "value", "$ref": "#/components/schemas/rapidid.api.aml.v1alpha.PepSanctionsResponse.SourceNote" } }, "title": "SourceNotesEntry", "additionalProperties": false }, "rapidid.api.aml.v1alpha.PepSanctionsResponse.Error": { "type": "object", "properties": { "code": { "type": [ "integer", "null" ], "title": "code", "format": "int32" }, "status": { "type": [ "string", "null" ], "title": "status" }, "message": { "type": [ "string", "null" ], "title": "message" } }, "title": "Error", "additionalProperties": false, "description": "Standard error handling" }, "rapidid.api.aml.v1alpha.PepSanctionsResponse.Field": { "type": "object", "properties": { "name": { "type": "string", "title": "name" }, "tag": { "type": [ "string", "null" ], "title": "tag" }, "value": { "type": "string", "title": "value" }, "locale": { "type": [ "string", "null" ], "title": "locale" } }, "title": "Field", "additionalProperties": false, "description": "Field information in documents" }, "rapidid.api.aml.v1alpha.PepSanctionsResponse.Filters": { "type": "object", "properties": { "birthYear": { "type": [ "integer", "null" ], "title": "birth_year", "format": "int32" }, "countryCodes": { "type": "array", "items": { "type": "string" }, "title": "country_codes" }, "exactMatch": { "type": "boolean", "title": "exact_match" }, "fuzziness": { "type": "number", "title": "fuzziness", "format": "float" }, "removeDeceased": { "type": "integer", "title": "remove_deceased", "format": "int32" }, "types": { "type": "array", "items": { "type": "string" }, "title": "types" } }, "title": "Filters", "additionalProperties": false, "description": "Search filters applied" }, "rapidid.api.aml.v1alpha.PepSanctionsResponse.Hit": { "type": "object", "properties": { "score": { "type": "number", "title": "score", "format": "float" }, "doc": { "title": "doc", "$ref": "#/components/schemas/rapidid.api.aml.v1alpha.PepSanctionsResponse.Document" }, "matchTypes": { "type": "array", "items": { "type": "string" }, "title": "match_types" }, "matchTypesDetails": { "type": "object", "title": "match_types_details", "additionalProperties": { "title": "value", "$ref": "#/components/schemas/rapidid.api.aml.v1alpha.PepSanctionsResponse.MatchTypeDetails" } }, "matchStatus": { "type": [ "string", "null" ], "title": "match_status" }, "isWhitelisted": { "type": [ "boolean", "null" ], "title": "is_whitelisted" } }, "title": "Hit", "additionalProperties": false, "description": "Individual hit information" }, "rapidid.api.aml.v1alpha.PepSanctionsResponse.Hit.MatchTypesDetailsEntry": { "type": "object", "properties": { "key": { "type": "string", "title": "key" }, "value": { "title": "value", "$ref": "#/components/schemas/rapidid.api.aml.v1alpha.PepSanctionsResponse.MatchTypeDetails" } }, "title": "MatchTypesDetailsEntry", "additionalProperties": false }, "rapidid.api.aml.v1alpha.PepSanctionsResponse.MatchStatus": { "type": "string", "title": "MatchStatus", "enum": [ "MATCH_STATUS_UNSPECIFIED", "MATCH_STATUS_TRUE_POSITIVE", "MATCH_STATUS_POTENTIAL_MATCH", "MATCH_STATUS_NO_MATCH" ], "description": "Match status" }, "rapidid.api.aml.v1alpha.PepSanctionsResponse.MatchTypeDetails": { "type": "object", "properties": { "matchTypes": { "type": "object", "title": "match_types", "additionalProperties": { "title": "value", "$ref": "#/components/schemas/rapidid.api.aml.v1alpha.PepSanctionsResponse.MatchTypeDetails.MatchTypeList" }, "description": "nested string arrays simplified to strings" }, "type": { "type": "string", "title": "type" } }, "title": "MatchTypeDetails", "additionalProperties": false, "description": "Match type details" }, "rapidid.api.aml.v1alpha.PepSanctionsResponse.MatchTypeDetails.MatchTypeList": { "type": "object", "properties": { "values": { "type": "array", "items": { "type": "string" }, "title": "values" } }, "title": "MatchTypeList", "additionalProperties": false, "description": "Nested string arrays: use a wrapper message around repeated string" }, "rapidid.api.aml.v1alpha.PepSanctionsResponse.MatchTypeDetails.MatchTypesEntry": { "type": "object", "properties": { "key": { "type": "string", "title": "key" }, "value": { "title": "value", "$ref": "#/components/schemas/rapidid.api.aml.v1alpha.PepSanctionsResponse.MatchTypeDetails.MatchTypeList" } }, "title": "MatchTypesEntry", "additionalProperties": false }, "rapidid.api.aml.v1alpha.PepSanctionsResponse.Media": { "type": "object", "properties": { "date": { "type": "string", "title": "date" }, "snippet": { "type": "string", "title": "snippet" }, "title": { "type": "string", "title": "title" }, "url": { "type": "string", "title": "url" } }, "title": "Media", "additionalProperties": false, "description": "Media information in documents" }, "rapidid.api.aml.v1alpha.PepSanctionsResponse.SourceNote": { "type": "object", "properties": { "name": { "type": "string", "title": "name" }, "url": { "type": "string", "title": "url" } }, "title": "SourceNote", "additionalProperties": false, "description": "Source note information" }, "rapidid.api.aml.v1alpha.PepSanctionsResponse.User": { "type": "object", "properties": { "id": { "type": [ "integer", "string" ], "title": "id", "format": "int64" }, "email": { "type": "string", "title": "email" }, "name": { "type": "string", "title": "name" }, "phone": { "type": [ "string", "null" ], "title": "phone" }, "createdAt": { "type": "string", "title": "created_at" }, "userIsActive": { "type": "boolean", "title": "user_is_active" } }, "title": "User", "additionalProperties": false, "description": "User information" }, "rapidid.api.dvs.v1alpha.ValidationResponse": { "type": "object", "properties": { "resultCode": { "title": "result_code", "$ref": "#/components/schemas/rapidid.api.dvs.v1alpha.VerificationStatus" }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/rapidid.api.dvs.v1alpha.ValidationResponse.Error" }, "title": "errors" }, "fieldMatches": { "type": "array", "items": { "$ref": "#/components/schemas/rapidid.api.dvs.v1alpha.ValidationResponse.FieldMatch" }, "title": "field_matches" } }, "title": "ValidationResponse", "additionalProperties": false, "description": "Common validation result object" }, "rapidid.api.dvs.v1alpha.ValidationResponse.Error": { "type": "object", "properties": { "field": { "type": "string", "title": "field" }, "message": { "type": "string", "title": "message" }, "source": { "type": "string", "title": "source" } }, "title": "Error", "additionalProperties": false }, "rapidid.api.dvs.v1alpha.ValidationResponse.FieldMatch": { "type": "object", "properties": { "field": { "type": "string", "title": "field" }, "matchedValue": { "type": "string", "title": "matched_value" } }, "title": "FieldMatch", "additionalProperties": false, "description": "Fields matched by the validation" }, "rapidid.api.dvs.v1alpha.VerificationStatus": { "type": "string", "title": "VerificationStatus", "enum": [ "VERIFICATION_STATUS_UNSPECIFIED", "VERIFICATION_STATUS_VERIFIED", "VERIFICATION_STATUS_NOT_VERIFIED", "VERIFICATION_STATUS_DOCUMENT_ERROR", "VERIFICATION_STATUS_SERVER_ERROR" ] }, "simplekyc.kyb.v1alpha.AbrAddressRegistration": { "type": "object", "properties": { "postCode": { "type": "string", "title": "post_code" }, "state": { "type": "string", "title": "state" }, "effectiveFrom": { "title": "effective_from", "description": "DD MMM YYYY", "$ref": "#/components/schemas/google.type.Date" }, "effectiveTo": { "title": "effective_to", "description": "DD MMM YYYY", "$ref": "#/components/schemas/google.type.Date" } }, "title": "AbrAddressRegistration", "additionalProperties": false }, "simplekyc.kyb.v1alpha.AbrHistoricalDetails": { "type": "object", "properties": { "entityName": { "type": "array", "items": { "$ref": "#/components/schemas/simplekyc.kyb.v1alpha.EffectiveValue" }, "title": "entity_name" }, "abnStatus": { "type": "array", "items": { "$ref": "#/components/schemas/simplekyc.kyb.v1alpha.EffectiveValue" }, "title": "abn_status" }, "entityType": { "type": "string", "title": "entity_type" }, "gstStatus": { "type": "array", "items": { "$ref": "#/components/schemas/simplekyc.kyb.v1alpha.EffectiveValue" }, "title": "gst_status" }, "mainBusinessLocation": { "type": "array", "items": { "$ref": "#/components/schemas/simplekyc.kyb.v1alpha.EffectiveValue" }, "title": "main_business_location" }, "businessName": { "type": "array", "items": { "$ref": "#/components/schemas/simplekyc.kyb.v1alpha.EffectiveValue" }, "title": "business_name" }, "tradingName": { "type": "array", "items": { "$ref": "#/components/schemas/simplekyc.kyb.v1alpha.EffectiveValue" }, "title": "trading_name" } }, "title": "AbrHistoricalDetails", "additionalProperties": false }, "simplekyc.kyb.v1alpha.ActivityLog": { "type": "object", "properties": { "kybProfile": { "title": "kyb_profile", "$ref": "#/components/schemas/simplekyc.kyb.v1alpha.KybProfile" }, "requestData": { "title": "request_data", "$ref": "#/components/schemas/simplekyc.kyb.v1alpha.CreateApplicationRequest" } }, "title": "ActivityLog", "required": [ "kybProfile", "requestData" ], "additionalProperties": false }, "simplekyc.kyb.v1alpha.AdditionalEntityInformation": { "type": "object", "properties": { "courtActions": { "type": "integer", "title": "court_actions", "format": "int32" }, "enquiries": { "type": "integer", "title": "enquiries", "format": "int32" }, "collections": { "type": "integer", "title": "collections", "format": "int32" }, "directors": { "type": "integer", "title": "directors", "format": "int32" }, "directorCourtActions": { "type": "integer", "title": "director_court_actions", "format": "int32" }, "directorFailedBusinesses": { "type": "integer", "title": "director_failed_businesses", "format": "int32" }, "tradeReferences": { "type": "integer", "title": "trade_references", "format": "int32" } }, "title": "AdditionalEntityInformation", "additionalProperties": false }, "simplekyc.kyb.v1alpha.Address": { "type": "object", "properties": { "type": { "type": "string", "title": "type" }, "lines": { "type": "array", "items": { "type": "string" }, "title": "lines" }, "unit": { "type": "string", "title": "unit" }, "number": { "type": "string", "title": "number" }, "street": { "type": "string", "title": "street" }, "neighbourhood": { "type": "string", "title": "neighbourhood" }, "city": { "type": "string", "title": "city" }, "postCode": { "type": "string", "title": "post_code" }, "state": { "type": "string", "title": "state" }, "countryCode": { "type": "string", "title": "country_code" }, "countryName": { "type": "string", "title": "country_name" }, "pafId": { "type": "string", "title": "paf_id" }, "startDate": { "title": "start_date", "description": "DD-MM-YYYY", "$ref": "#/components/schemas/google.type.Date" }, "endDate": { "title": "end_date", "description": "DD-MM-YYYY", "$ref": "#/components/schemas/google.type.Date" }, "coords": { "title": "coords", "$ref": "#/components/schemas/simplekyc.kyb.v1alpha.AddressCoordinates" }, "careOf": { "type": "string", "title": "care_of" }, "main": { "type": "boolean", "title": "main" }, "formatted": { "type": "boolean", "title": "formatted" }, "unformattedAddress": { "type": "string", "title": "unformatted_address" }, "poBox": { "type": "string", "title": "po_box" }, "level": { "type": "string", "title": "level" }, "stairCase": { "type": "string", "title": "stair_case" }, "entrance": { "type": "string", "title": "entrance" }, "suburb": { "type": "string", "title": "suburb" }, "cityDistrict": { "type": "string", "title": "city_district" }, "island": { "type": "string", "title": "island" }, "house": { "type": "string", "title": "house" }, "stateDistrict": { "type": "string", "title": "state_district" }, "countryRegion": { "type": "string", "title": "country_region" }, "source": { "type": "string", "title": "source" }, "sourceRole": { "type": "string", "title": "source_role" }, "modified": { "type": "boolean", "title": "modified" } }, "title": "Address", "additionalProperties": false }, "simplekyc.kyb.v1alpha.AddressCoordinates": { "type": "object", "properties": { "lat": { "type": "string", "title": "lat" }, "lng": { "type": "string", "title": "lng" } }, "title": "AddressCoordinates", "additionalProperties": false }, "simplekyc.kyb.v1alpha.ApplicationMetadata": { "type": "object", "properties": { "applicationId": { "type": "string", "title": "application_id", "description": "The ID of the application" }, "entityId": { "type": "string", "title": "entity_id", "description": "The Entity ID the application was created for" }, "createdAt": { "type": "string", "title": "created_at", "description": "The timestamp of when the application was created" } }, "title": "ApplicationMetadata", "required": [ "applicationId", "entityId" ], "additionalProperties": false }, "simplekyc.kyb.v1alpha.AsicCheckResult": { "type": "object", "properties": { "dataSet": { "type": "string", "title": "data_set" }, "result": { "type": "string", "title": "result" } }, "title": "AsicCheckResult", "additionalProperties": false }, "simplekyc.kyb.v1alpha.AsicDocumentDetail": { "type": "object", "properties": { "formCode": { "type": "string", "title": "form_code" }, "description": { "type": "string", "title": "description" } }, "title": "AsicDocumentDetail", "additionalProperties": false }, "simplekyc.kyb.v1alpha.AsicDocumentLodgement": { "type": "object", "properties": { "documentNumber": { "type": "string", "title": "document_number" }, "receivedDate": { "title": "received_date", "description": "DD-MM-YYYY", "$ref": "#/components/schemas/google.type.Date" }, "formCode": { "type": "string", "title": "form_code" }, "description": { "type": "string", "title": "description" }, "detailedDescription": { "type": "array", "items": { "$ref": "#/components/schemas/simplekyc.kyb.v1alpha.AsicDocumentDetail" }, "title": "detailed_description" } }, "title": "AsicDocumentLodgement", "additionalProperties": false }, "simplekyc.kyb.v1alpha.AustracDetail": { "type": "object", "properties": { "legalName": { "type": "string", "title": "legal_name" }, "tradingName": { "type": "string", "title": "trading_name" }, "address": { "title": "address", "$ref": "#/components/schemas/simplekyc.kyb.v1alpha.Address" }, "abn": { "type": "integer", "title": "abn", "format": "int32" }, "acn": { "type": "integer", "title": "acn", "format": "int32" }, "arbn": { "type": "integer", "title": "arbn", "format": "int32" } }, "title": "AustracDetail", "additionalProperties": false }, "simplekyc.kyb.v1alpha.BusinessNumber": { "type": "object", "properties": { "number": { "type": "string", "title": "number", "pattern": "^(\\d{9}|\\d{11})$" }, "status": { "type": "string", "title": "status" } }, "title": "BusinessNumber", "additionalProperties": false }, "simplekyc.kyb.v1alpha.BusinessOverview": { "type": "object", "properties": { "legalBusinessName": { "type": "string", "title": "legal_business_name", "description": "Identifiers" }, "entityType": { "type": "string", "title": "entity_type" }, "abn": { "title": "abn", "$ref": "#/components/schemas/simplekyc.kyb.v1alpha.BusinessNumber" }, "acn": { "title": "acn", "$ref": "#/components/schemas/simplekyc.kyb.v1alpha.BusinessNumber" }, "parentCompany": { "type": "string", "title": "parent_company" }, "establishmentDate": { "title": "establishment_date", "description": "DD-MM-YYYY", "$ref": "#/components/schemas/google.type.Date" }, "establishmentCountry": { "type": "string", "title": "establishment_country" }, "deregisteredDate": { "title": "deregistered_date", "description": "DD-MM-YYYY", "$ref": "#/components/schemas/google.type.Date" }, "principalPlaceOfBusiness": { "title": "principal_place_of_business", "description": "Addresses", "$ref": "#/components/schemas/simplekyc.kyb.v1alpha.Address" }, "registeredOffice": { "title": "registered_office", "$ref": "#/components/schemas/simplekyc.kyb.v1alpha.Address" }, "registeredLocation": { "title": "registered_location", "$ref": "#/components/schemas/simplekyc.kyb.v1alpha.Address" }, "mailingAddress": { "title": "mailing_address", "$ref": "#/components/schemas/simplekyc.kyb.v1alpha.Address" }, "abrAddressRegistration": { "title": "abr_address_registration", "$ref": "#/components/schemas/simplekyc.kyb.v1alpha.AbrAddressRegistration" }, "email": { "type": "string", "title": "email", "description": "Contact" }, "website": { "type": "string", "title": "website" }, "phone": { "type": "string", "title": "phone" }, "companyClass": { "title": "company_class", "description": "Industry info", "$ref": "#/components/schemas/simplekyc.kyb.v1alpha.CompanyClass" }, "nonProfitType": { "type": "string", "title": "non_profit_type" }, "trustType": { "type": "string", "title": "trust_type" }, "distributionType": { "type": "string", "title": "distribution_type" }, "sicCode": { "type": "string", "title": "sic_code" }, "lineOfBusiness": { "type": "string", "title": "line_of_business" }, "duns": { "type": "string", "title": "duns", "description": "Misc" }, "gstStatus": { "type": "string", "title": "gst_status" }, "abnLastUpdated": { "title": "abn_last_updated", "description": "DD-MM-YYYY", "$ref": "#/components/schemas/google.type.Date" }, "nextReviewDate": { "title": "next_review_date", "description": "DD-MM-YYYY", "$ref": "#/components/schemas/google.type.Date" } }, "title": "BusinessOverview", "required": [ "legalBusinessName", "entityType" ], "additionalProperties": false, "description": "Corresponds to the \"EntityDetails\" object" }, "simplekyc.kyb.v1alpha.CompanyClass": { "type": "object", "properties": { "type": { "type": "string", "title": "type" }, "class": { "type": "string", "title": "class" }, "subclass": { "type": "string", "title": "subclass" } }, "title": "CompanyClass", "additionalProperties": false }, "simplekyc.kyb.v1alpha.CreateApplicationRequest": { "type": "object", "allOf": [ { "properties": { "entity": { "type": "string", "title": "entity", "minLength": 1, "pattern": "^entities/[a-zA-Z0-9-_]+$", "description": "The entity resource name\n Format: entities/{entity}" }, "businessName": { "type": "string", "title": "business_name", "description": "The business name to use" } } }, { "oneOf": [ { "type": "object", "properties": { "abn": { "type": "string", "examples": [ "51824753556" ], "title": "abn", "pattern": "^\\d{11}$" } }, "title": "abn", "required": [ "abn" ] }, { "type": "object", "properties": { "acn": { "type": "string", "examples": [ "123456789" ], "title": "acn", "pattern": "^\\d{9}$" } }, "title": "acn", "required": [ "acn" ] } ] } ], "title": "CreateApplicationRequest", "additionalProperties": false }, "simplekyc.kyb.v1alpha.EffectiveValue": { "type": "object", "properties": { "value": { "type": "string", "title": "value" }, "effectiveFrom": { "title": "effective_from", "description": "DD-MM-YYYY", "$ref": "#/components/schemas/google.type.Date" }, "effectiveTo": { "type": "string", "title": "effective_to", "description": "DD-MM-YYYY or (Current)" } }, "title": "EffectiveValue", "additionalProperties": false }, "simplekyc.kyb.v1alpha.FairTradingAssociation": { "type": "object", "properties": { "registrationId": { "type": "string", "title": "registration_id" }, "name": { "type": "string", "title": "name" } }, "title": "FairTradingAssociation", "additionalProperties": false }, "simplekyc.kyb.v1alpha.FairTradingDetail": { "type": "object", "properties": { "associationDetails": { "title": "association_details", "$ref": "#/components/schemas/simplekyc.kyb.v1alpha.FairTradingAssociation" } }, "title": "FairTradingDetail", "additionalProperties": false }, "simplekyc.kyb.v1alpha.InterestedPerson": { "type": "object", "properties": { "id": { "type": "integer", "title": "id", "format": "int32" }, "firstName": { "type": "string", "title": "first_name" }, "middleName": { "type": "string", "title": "middle_name" }, "lastName": { "type": "string", "title": "last_name" }, "unstructuredName": { "type": "string", "title": "unstructured_name" }, "roles": { "type": "string", "title": "roles" }, "ownership": { "type": "string", "title": "ownership" }, "dateOfBirth": { "title": "date_of_birth", "description": "DD-MM-YYYY", "$ref": "#/components/schemas/google.type.Date" }, "address": { "title": "address", "$ref": "#/components/schemas/simplekyc.kyb.v1alpha.Address" }, "countryCode": { "type": "string", "title": "country_code" }, "signatoryStatus": { "type": "string", "title": "signatory_status" }, "idVerificationStatus": { "type": "string", "title": "id_verification_status" }, "proofOfAddressStatus": { "type": "string", "title": "proof_of_address_status" }, "pepAndSanctionsStatus": { "type": "string", "title": "pep_and_sanctions_status" }, "mediaCheckStatus": { "type": "string", "title": "media_check_status" } }, "title": "InterestedPerson", "additionalProperties": false }, "simplekyc.kyb.v1alpha.IntermediateBeneficialOwner": { "type": "object", "properties": { "id": { "type": "integer", "title": "id", "format": "int32" }, "name": { "type": "string", "title": "name" }, "roles": { "type": "string", "title": "roles" }, "entityType": { "type": "string", "title": "entity_type" }, "ownership": { "type": "string", "title": "ownership" }, "abn": { "type": "string", "title": "abn" }, "acn": { "type": "string", "title": "acn" }, "address": { "title": "address", "$ref": "#/components/schemas/simplekyc.kyb.v1alpha.Address" }, "countryCode": { "type": "string", "title": "country_code" }, "pepAndSanctionsStatus": { "type": "string", "title": "pep_and_sanctions_status" }, "mediaCheckStatus": { "type": "string", "title": "media_check_status" }, "other": { "type": "string", "title": "other" } }, "title": "IntermediateBeneficialOwner", "additionalProperties": false }, "simplekyc.kyb.v1alpha.InvestigationFlag": { "type": "object", "properties": { "colour": { "title": "colour", "$ref": "#/components/schemas/simplekyc.kyb.v1alpha.InvestigationFlagColor" }, "name": { "type": "string", "title": "name" }, "detail": { "type": "string", "title": "detail" }, "descriptor": { "title": "descriptor", "$ref": "#/components/schemas/simplekyc.kyb.v1alpha.InvestigationFlagDescriptor" } }, "title": "InvestigationFlag", "additionalProperties": false }, "simplekyc.kyb.v1alpha.InvestigationFlagColor": { "type": "string", "title": "InvestigationFlagColor", "enum": [ "INVESTIGATION_FLAG_COLOR_UNSPECIFIED", "INVESTIGATION_FLAG_COLOR_LIGHT_GREY", "INVESTIGATION_FLAG_COLOR_BLUE", "INVESTIGATION_FLAG_COLOR_ORANGE", "INVESTIGATION_FLAG_COLOR_RED" ] }, "simplekyc.kyb.v1alpha.InvestigationFlagDescriptor": { "type": "string", "title": "InvestigationFlagDescriptor", "enum": [ "INVESTIGATION_FLAG_DESCRIPTOR_UNSPECIFIED", "INVESTIGATION_FLAG_DESCRIPTOR_TRUST_FLAG", "INVESTIGATION_FLAG_DESCRIPTOR_STATUS_FLAG", "INVESTIGATION_FLAG_DESCRIPTOR_COUNTRY_FLAG", "INVESTIGATION_FLAG_DESCRIPTOR_PANAMA_FLAG", "INVESTIGATION_FLAG_DESCRIPTOR_JOINT_OWNERSHIP_FLAG", "INVESTIGATION_FLAG_DESCRIPTOR_NON_BENEFICIALLY_HELD_SHARES_FLAG", "INVESTIGATION_FLAG_DESCRIPTOR_DATA_SHARE_FLAG", "INVESTIGATION_FLAG_DESCRIPTOR_PULLED_FAIL_FLAG", "INVESTIGATION_FLAG_DESCRIPTOR_UNLISTED_PUBLIC_COMPANY_FLAG", "INVESTIGATION_FLAG_DESCRIPTOR_LISTED_PUBLIC_COMPANY_FLAG", "INVESTIGATION_FLAG_DESCRIPTOR_GENERIC_PUBLIC_COMPANY_FLAG", "INVESTIGATION_FLAG_DESCRIPTOR_GST_FLAG", "INVESTIGATION_FLAG_DESCRIPTOR_DATA_ISSUE_FLAG", "INVESTIGATION_FLAG_DESCRIPTOR_POSSIBLE_PUBLIC_COMPANY_FLAG", "INVESTIGATION_FLAG_DESCRIPTOR_SMF_NOT_COMPLYING", "INVESTIGATION_FLAG_DESCRIPTOR_VERIFICATION_FAILED", "INVESTIGATION_FLAG_DESCRIPTOR_NODE_UNLOCKED", "INVESTIGATION_FLAG_DESCRIPTOR_PEP_AND_SANCTIONS_FLAG", "INVESTIGATION_FLAG_DESCRIPTOR_PEP_FLAG", "INVESTIGATION_FLAG_DESCRIPTOR_SANCTIONS_FLAG", "INVESTIGATION_FLAG_DESCRIPTOR_TR_MISSING_SIGNATURE", "INVESTIGATION_FLAG_DESCRIPTOR_TR_MISSING_CERTIFICATION", "INVESTIGATION_FLAG_DESCRIPTOR_RECURSIVE_FLAG", "INVESTIGATION_FLAG_DESCRIPTOR_NO_CHARITY", "INVESTIGATION_FLAG_DESCRIPTOR_INDUSTRIES_FLAG", "INVESTIGATION_FLAG_DESCRIPTOR_UNIDENTIFIED_FLAG", "INVESTIGATION_FLAG_DESCRIPTOR_NO_SIGNIFICANT_SHAREHOLDERS", "INVESTIGATION_FLAG_DESCRIPTOR_UNDERTAKINGS_REGISTER", "INVESTIGATION_FLAG_DESCRIPTOR_DISQUALIFICATION_REGISTER", "INVESTIGATION_FLAG_DESCRIPTOR_DISQUALIFICATION_REVOKED_REGISTER", "INVESTIGATION_FLAG_DESCRIPTOR_UNACCOUNTED_SHARES_FLAG", "INVESTIGATION_FLAG_DESCRIPTOR_FOREIGN_ENTITY_BO_FLAG", "INVESTIGATION_FLAG_DESCRIPTOR_FOREIGN_INDIVIDUAL_BO_FLAG", "INVESTIGATION_FLAG_DESCRIPTOR_UNKNOWN_FLAG", "INVESTIGATION_FLAG_DESCRIPTOR_MULTIPLE_POSSIBLE_MATCHES_FOUND" ] }, "simplekyc.kyb.v1alpha.IssuedCapital": { "type": "object", "properties": { "documentNumber": { "type": "string", "title": "document_number" }, "classCode": { "type": "string", "title": "class_code" }, "classTitle": { "type": "string", "title": "class_title" }, "sharesIssued": { "type": "string", "title": "shares_issued" }, "totalPaidOnShares": { "type": "string", "title": "total_paid_on_shares" }, "totalAmountDue": { "type": "string", "title": "total_amount_due" } }, "title": "IssuedCapital", "additionalProperties": false }, "simplekyc.kyb.v1alpha.KybProfile": { "type": "object", "properties": { "metadata": { "title": "metadata", "$ref": "#/components/schemas/simplekyc.kyb.v1alpha.ApplicationMetadata" }, "businessOverview": { "title": "business_overview", "$ref": "#/components/schemas/simplekyc.kyb.v1alpha.BusinessOverview" }, "businessNames": { "type": "array", "items": { "$ref": "#/components/schemas/simplekyc.kyb.v1alpha.EffectiveValue" }, "title": "business_names" }, "tradingNames": { "type": "array", "items": { "$ref": "#/components/schemas/simplekyc.kyb.v1alpha.EffectiveValue" }, "title": "trading_names" }, "formerNames": { "type": "array", "items": { "$ref": "#/components/schemas/simplekyc.kyb.v1alpha.EffectiveValue" }, "title": "former_names" }, "abrHistoricalDetails": { "title": "abr_historical_details", "$ref": "#/components/schemas/simplekyc.kyb.v1alpha.AbrHistoricalDetails" }, "interestedPersons": { "type": "array", "items": { "$ref": "#/components/schemas/simplekyc.kyb.v1alpha.InterestedPerson" }, "title": "interested_persons" }, "nonBeneficialOwnership": { "type": "array", "items": { "$ref": "#/components/schemas/simplekyc.kyb.v1alpha.NonBeneficialOwner" }, "title": "non_beneficial_ownership" }, "intermediateBeneficialOwnership": { "type": "array", "items": { "$ref": "#/components/schemas/simplekyc.kyb.v1alpha.IntermediateBeneficialOwner" }, "title": "intermediate_beneficial_ownership" }, "ultimateOwnership": { "title": "ultimate_ownership", "$ref": "#/components/schemas/simplekyc.kyb.v1alpha.UltimateOwnership" }, "unidentifiedParties": { "type": "array", "items": { "$ref": "#/components/schemas/simplekyc.kyb.v1alpha.UnidentifiedParty" }, "title": "unidentified_parties" }, "investigationFlags": { "type": "array", "items": { "$ref": "#/components/schemas/simplekyc.kyb.v1alpha.InvestigationFlag" }, "title": "investigation_flags" }, "entitiesDetail": { "type": "array", "items": { "$ref": "#/components/schemas/simplekyc.kyb.v1alpha.RelatedEntity" }, "title": "entities_detail" }, "webLinks": { "title": "web_links", "$ref": "#/components/schemas/simplekyc.kyb.v1alpha.WebLinks" }, "rawResponse": { "type": "string", "title": "raw_response" } }, "title": "KybProfile", "additionalProperties": false, "description": "Loosely corresponds to the \"GetDataApiResponse\".data object" }, "simplekyc.kyb.v1alpha.NonBeneficialOwner": { "type": "object", "properties": { "id": { "type": "integer", "title": "id", "format": "int32" }, "name": { "type": "string", "title": "name" }, "entityType": { "type": "string", "title": "entity_type" }, "ownership": { "type": "string", "title": "ownership" }, "abn": { "type": "string", "title": "abn" }, "acn": { "type": "string", "title": "acn" }, "address": { "title": "address", "$ref": "#/components/schemas/simplekyc.kyb.v1alpha.Address" }, "countryCode": { "type": "string", "title": "country_code" } }, "title": "NonBeneficialOwner", "additionalProperties": false }, "simplekyc.kyb.v1alpha.OfficerRole": { "type": "object", "properties": { "firstName": { "type": "string", "title": "first_name" }, "middleName": { "type": "string", "title": "middle_name" }, "lastName": { "type": "string", "title": "last_name" }, "unstructuredName": { "type": "string", "title": "unstructured_name" }, "role": { "type": "string", "title": "role" }, "residentialAddress": { "title": "residential_address", "$ref": "#/components/schemas/simplekyc.kyb.v1alpha.Address" }, "dateOfBirth": { "title": "date_of_birth", "description": "DD-MM-YYYY", "$ref": "#/components/schemas/google.type.Date" }, "placeOfBirth": { "type": "string", "title": "place_of_birth" }, "appointmentDate": { "title": "appointment_date", "description": "DD-MM-YYYY", "$ref": "#/components/schemas/google.type.Date" }, "source": { "type": "string", "title": "source" } }, "title": "OfficerRole", "additionalProperties": false }, "simplekyc.kyb.v1alpha.OwnershipStructure": { "type": "object", "properties": { "issuedCapital": { "type": "array", "items": { "$ref": "#/components/schemas/simplekyc.kyb.v1alpha.IssuedCapital" }, "title": "issued_capital" }, "shareholders": { "type": "array", "items": { "$ref": "#/components/schemas/simplekyc.kyb.v1alpha.ShareholderDetails" }, "title": "shareholders" }, "partners": { "type": "array", "items": { "$ref": "#/components/schemas/simplekyc.kyb.v1alpha.ShareholderDetails" }, "title": "partners" } }, "title": "OwnershipStructure", "additionalProperties": false }, "simplekyc.kyb.v1alpha.RelatedEntity": { "type": "object", "properties": { "name": { "type": "string", "title": "name" }, "sources": { "type": "array", "items": { "$ref": "#/components/schemas/simplekyc.kyb.v1alpha.Source" }, "title": "sources" }, "entityDetails": { "title": "entity_details", "$ref": "#/components/schemas/simplekyc.kyb.v1alpha.BusinessOverview" }, "businessNames": { "type": "array", "items": { "$ref": "#/components/schemas/simplekyc.kyb.v1alpha.EffectiveValue" }, "title": "business_names" }, "tradingNames": { "type": "array", "items": { "$ref": "#/components/schemas/simplekyc.kyb.v1alpha.EffectiveValue" }, "title": "trading_names" }, "formerNames": { "type": "array", "items": { "$ref": "#/components/schemas/simplekyc.kyb.v1alpha.EffectiveValue" }, "title": "former_names" }, "abrHistoricalDetails": { "title": "abr_historical_details", "$ref": "#/components/schemas/simplekyc.kyb.v1alpha.AbrHistoricalDetails" }, "primaryCustomerChecks": { "type": "array", "items": { "$ref": "#/components/schemas/simplekyc.kyb.v1alpha.AsicCheckResult" }, "title": "primary_customer_checks" }, "ultimateBeneficialOwnerChecks": { "type": "array", "items": { "$ref": "#/components/schemas/simplekyc.kyb.v1alpha.AsicCheckResult" }, "title": "ultimate_beneficial_owner_checks" }, "ownershipStructure": { "title": "ownership_structure", "$ref": "#/components/schemas/simplekyc.kyb.v1alpha.OwnershipStructure" }, "officers": { "type": "array", "items": { "$ref": "#/components/schemas/simplekyc.kyb.v1alpha.OfficerRole" }, "title": "officers" }, "additionalInformation": { "title": "additional_information", "$ref": "#/components/schemas/simplekyc.kyb.v1alpha.AdditionalEntityInformation" }, "asicDocumentLodgements": { "type": "array", "items": { "$ref": "#/components/schemas/simplekyc.kyb.v1alpha.AsicDocumentLodgement" }, "title": "asic_document_lodgements" }, "austrac": { "title": "austrac", "$ref": "#/components/schemas/simplekyc.kyb.v1alpha.AustracDetail" }, "fairTrading": { "title": "fair_trading", "$ref": "#/components/schemas/simplekyc.kyb.v1alpha.FairTradingDetail" }, "trusts": { "title": "trusts", "$ref": "#/components/schemas/simplekyc.kyb.v1alpha.TrustDetail" }, "professionalRegisterVerification": { "type": "array", "items": { "$ref": "#/components/schemas/simplekyc.kyb.v1alpha.AsicCheckResult" }, "title": "professional_register_verification" } }, "title": "RelatedEntity", "additionalProperties": false }, "simplekyc.kyb.v1alpha.ShareholderDetails": { "type": "object", "properties": { "firstName": { "type": "string", "title": "first_name" }, "middleName": { "type": "string", "title": "middle_name" }, "lastName": { "type": "string", "title": "last_name" }, "unstructuredName": { "type": "string", "title": "unstructured_name" }, "entityType": { "type": "string", "title": "entity_type" }, "acn": { "type": "string", "title": "acn" }, "address": { "title": "address", "$ref": "#/components/schemas/simplekyc.kyb.v1alpha.Address" }, "dateOfBirth": { "title": "date_of_birth", "description": "DD-MM-YYYY", "$ref": "#/components/schemas/google.type.Date" }, "classCode": { "type": "string", "title": "class_code" }, "sharesHeld": { "type": "string", "title": "shares_held" }, "percentageInShareClass": { "type": "string", "title": "percentage_in_share_class" }, "beneficiallyHeld": { "type": "string", "title": "beneficially_held" }, "paid": { "type": "string", "title": "paid" }, "documentNumber": { "type": "string", "title": "document_number" }, "source": { "type": "string", "title": "source" } }, "title": "ShareholderDetails", "additionalProperties": false }, "simplekyc.kyb.v1alpha.Source": { "type": "object", "properties": { "source": { "type": "string", "title": "source" }, "extractDate": { "title": "extract_date", "description": "DD-MM-YYYY", "$ref": "#/components/schemas/google.type.Date" }, "status": { "type": "string", "title": "status" } }, "title": "Source", "additionalProperties": false }, "simplekyc.kyb.v1alpha.TrustBeneficiary": { "type": "object", "properties": { "firstName": { "type": "string", "title": "first_name" }, "middleName": { "type": "string", "title": "middle_name" }, "lastName": { "type": "string", "title": "last_name" }, "unstructuredName": { "type": "string", "title": "unstructured_name" }, "type": { "type": "string", "title": "type" }, "entityType": { "type": "string", "title": "entity_type" }, "acn": { "type": "string", "title": "acn" }, "address": { "title": "address", "$ref": "#/components/schemas/simplekyc.kyb.v1alpha.Address" }, "dateOfBirth": { "title": "date_of_birth", "description": "DD-MM-YYYY", "$ref": "#/components/schemas/google.type.Date" }, "sharesUnitsHeld": { "type": "integer", "title": "shares_units_held", "format": "int32" }, "percentageSharesUnits": { "type": "string", "title": "percentage_shares_units" }, "source": { "type": "string", "title": "source" } }, "title": "TrustBeneficiary", "additionalProperties": false }, "simplekyc.kyb.v1alpha.TrustDetail": { "type": "object", "properties": { "distributionStructure": { "title": "distribution_structure", "$ref": "#/components/schemas/simplekyc.kyb.v1alpha.TrustDistributionStructure" }, "beneficiaries": { "type": "array", "items": { "$ref": "#/components/schemas/simplekyc.kyb.v1alpha.TrustBeneficiary" }, "title": "beneficiaries" }, "otherRoles": { "type": "array", "items": { "$ref": "#/components/schemas/simplekyc.kyb.v1alpha.TrustOtherRoles" }, "title": "other_roles" } }, "title": "TrustDetail", "additionalProperties": false }, "simplekyc.kyb.v1alpha.TrustDistributionStructure": { "type": "object", "properties": { "calculationMethod": { "type": "string", "title": "calculation_method" }, "sharesUnitsIssued": { "type": "integer", "title": "shares_units_issued", "format": "int32" }, "extensiveShareholding": { "type": "string", "title": "extensive_shareholding" } }, "title": "TrustDistributionStructure", "additionalProperties": false }, "simplekyc.kyb.v1alpha.TrustOtherRoles": { "type": "object", "properties": { "firstName": { "type": "string", "title": "first_name" }, "middleName": { "type": "string", "title": "middle_name" }, "lastName": { "type": "string", "title": "last_name" }, "unstructuredName": { "type": "string", "title": "unstructured_name" }, "role": { "type": "string", "title": "role" }, "entity": { "type": "string", "title": "entity" }, "dateOfBirth": { "title": "date_of_birth", "description": "DD-MM-YYYY", "$ref": "#/components/schemas/google.type.Date" }, "abn": { "type": "string", "title": "abn" } }, "title": "TrustOtherRoles", "additionalProperties": false }, "simplekyc.kyb.v1alpha.UltimateIndividualOwner": { "type": "object", "properties": { "firstName": { "type": "string", "title": "first_name" }, "middleName": { "type": "string", "title": "middle_name" }, "lastName": { "type": "string", "title": "last_name" }, "unstructuredName": { "type": "string", "title": "unstructured_name" }, "dateOfBirth": { "title": "date_of_birth", "description": "DD-MM-YYYY", "$ref": "#/components/schemas/google.type.Date" }, "address": { "title": "address", "$ref": "#/components/schemas/simplekyc.kyb.v1alpha.Address" }, "countryCode": { "type": "string", "title": "country_code" }, "totalOwnership": { "type": "string", "title": "total_ownership" }, "beneficialOwnership": { "type": "string", "title": "beneficial_ownership" }, "nonBeneficialOwnership": { "type": "string", "title": "non_beneficial_ownership" } }, "title": "UltimateIndividualOwner", "additionalProperties": false }, "simplekyc.kyb.v1alpha.UltimateNonIndividualOwner": { "type": "object", "properties": { "name": { "type": "string", "title": "name" }, "entity": { "type": "string", "title": "entity" }, "abn": { "type": "string", "title": "abn" }, "acn": { "type": "string", "title": "acn" }, "address": { "title": "address", "$ref": "#/components/schemas/simplekyc.kyb.v1alpha.Address" }, "countryCode": { "type": "string", "title": "country_code" }, "totalOwnership": { "type": "string", "title": "total_ownership" }, "beneficialOwnership": { "type": "string", "title": "beneficial_ownership" }, "possibleNomineeOwnership": { "type": "string", "title": "possible_nominee_ownership" } }, "title": "UltimateNonIndividualOwner", "additionalProperties": false }, "simplekyc.kyb.v1alpha.UltimateOwnership": { "type": "object", "properties": { "naturalPeople": { "type": "array", "items": { "$ref": "#/components/schemas/simplekyc.kyb.v1alpha.UltimateIndividualOwner" }, "title": "natural_people" }, "holdingEntities": { "type": "array", "items": { "$ref": "#/components/schemas/simplekyc.kyb.v1alpha.UltimateNonIndividualOwner" }, "title": "holding_entities" } }, "title": "UltimateOwnership", "additionalProperties": false }, "simplekyc.kyb.v1alpha.UnidentifiedParty": { "type": "object", "properties": { "id": { "type": "integer", "title": "id", "format": "int32" }, "name": { "type": "string", "title": "name" }, "entityType": { "type": "string", "title": "entity_type" }, "ownership": { "type": "string", "title": "ownership" }, "address": { "title": "address", "$ref": "#/components/schemas/simplekyc.kyb.v1alpha.Address" }, "countryCode": { "type": "string", "title": "country_code" }, "other": { "type": "string", "title": "other" }, "abn": { "type": "string", "title": "abn" }, "acn": { "type": "string", "title": "acn" } }, "title": "UnidentifiedParty", "additionalProperties": false }, "simplekyc.kyb.v1alpha.WebLinks": { "type": "object", "properties": { "tree": { "type": "string", "title": "tree" }, "report": { "type": "string", "title": "report" } }, "title": "WebLinks", "additionalProperties": false } }, "securitySchemes": { "oauth2_client_credentials": { "type": "oauth2", "flows": { "clientCredentials": { "tokenUrl": "https://auth.bndry.app/realms/bndry/protocol/openid-connect/token", "scopes": {} } } }, "oauth2_authorization_code": { "type": "oauth2", "flows": { "authorizationCode": { "x-usePkce": { "disableManualConfiguration": true, "hideClientSecretInput": true }, "authorizationUrl": "https://auth.bndry.app/realms/bndry/protocol/openid-connect/auth", "tokenUrl": "https://auth.bndry.app/realms/bndry/protocol/openid-connect/token" } } } } }, "security": [ { "oauth2_client_credentials": [] }, { "oauth2_authorization_code": [] } ], "tags": [ { "name": "Forms" }, { "name": "Entities" }, { "name": "ActivityService" }, { "name": "Entity Risk Rating", "description": "Service for managing risk rating jobs for individual entities." }, { "name": "Individual Entity Verification", "description": "Service for managing individual entity verification jobs." }, { "name": "Onboard Individual Entity", "description": "Service for managing individual entity onboarding jobs." }, { "name": "PepSanctionBusinessEntityJobService", "description": "Service for managing PEP and sanctions screening jobs for business entities." }, { "name": "Entity PEP Sanctions Check", "description": "Service for managing PEP and sanctions screening jobs for individual entities." } ] }