Skip to main content

Veritran Docs

Biocatch

The Biocatch integration allows you to learn the behavior of users when they are using the app, and detect unusual events. This helps reduce online fraud and protect against cyber threats. Advantages of this integration include:

  • Optimizing fraud investigations with access to detailed session context.

  • Decreasing time to action by understanding the exact behavioral indicators that contributed to a session’s risk score.

  • Driving complex case resolution using a powerful set of visualization tools.

  • Revealing fraud trends via automated query capabilities.

Note

The integration described in this article may not be implemented in your environment or enabled for all your clients. Contact your admin for assistance.

Technical Details
Use the Biocatch Integration in Studio

The following functions are available for use in your legacy processes, and you can also use them as blocks in Lambda processes. Click each function to see more details.

Start

Initialize the Biocatch SDK.

Update Customer Session ID

Update the Customer Session ID (CSID).

Change Context

Assign the current context of the application.

Get State

Get the current status of the Biocatch SDK.

Stop

Stop the Biocatch SDK.

Pause

Pause the Biocatch SDK.

Resume

Resume the Biocatch SDK after being paused.

Start

This function initializes the Biocatch SDK and starts sending the collection of user session data.

Parameter Configuration

This function doesn't require the configuration of any parameters.

Function ID

Register

Value

110

1

Input Registers

Register

Description

Mandatory

Value

-

Wup URL

Yes

String

Output Registers

Register

Description

Value

112

Call Result

000

NO_ERROR

001

API_GENERIC_ERROR

002

API_WRONG_PARAMETERS_ERROR

003

API_NOT_IN_STOPPED_STATE

006

PERMISSIONS_NOT_GRANTED

Update Customer Session ID

This function allows you to update the Customer Session ID (CSID). This allows Biocatch to maintain a mapping between its own internal session number and the generated CSIDs. The CSID must be updated every time a session is restarted and right after the Start function has been called.

Parameter Configuration

This function requires you to complete the input register value with the Biocatch Customer Session ID.

Function ID

Register

Value

110

1

Input Registers

Register

Description

Mandatory

Value

390

Customer Session ID

Yes

[Biocatch Customer Session ID]

Output Registers

Register

Description

Value

112

Call Result

000

NO_ERROR

001

API_GENERIC_ERROR

002

API_WRONG_PARAMETERS_ERROR

006

PERMISSIONS_NOT_GRANTED

Change Context

This function is used to assign and inform Biocatch of the current context or view in which the application is located.

Parameter Configuration

This function requires you to complete the input register value with the current context or view in which the application is located.

Function ID

Register

Value

110

1

Input Registers

Register

Description

Mandatory

Value

390

Context Tag

Yes

[Context or view description]

Output Registers

Register

Description

Value

112

Call Result

000

NO_ERROR

001

API_GENERIC_ERROR

002

API_WRONG_PARAMETERS_ERROR

006

PERMISSIONS_NOT_GRANTED

Get State

This function is used to get the current status of the Biocatch SDK.

Parameter Configuration

This function doesn't require the configuration of any parameters.

Function ID

Register

Value

110

1

Output Registers

Register

Description

Value

112

Call result

000

NO_ERROR

001

API_GENERIC_ERROR

006

PERMISSIONS_NOT_GRANTED

Stop

This function stops the Biocatch SDK and clears memory when the application exits.

Parameter Configuration

This function doesn't require the configuration of any parameters.

Function ID

Register

Value

110

1

Output Registers

Register

Description

Value

112

Call result

000

NO_ERROR

001

API_GENERIC_ERROR

006

PERMISSIONS_NOT_GRANTED

Pause

This function temporarily suspends the collection of the Biocatch SDK data. It is called when the user performs irrelevant activities to temporarily avoid using system resources to collect and send data.

Parameter Configuration

This function doesn't require the configuration of any parameters.

Function ID

Register

Value

110

1

Output Registers

Register

Description

Value

112

Call result

000

NO_ERROR

001

API_GENERIC_ERROR

004

API_NOT_IN_STARTED_STATE

006

PERMISSIONS_NOT_GRANTED

Resume

This function restores the Biocatch SDK data collection after it has been paused.

Parameter Configuration

This function doesn't require the configuration of any parameters.

Function ID

Register

Value

110

1

Output Registers

Register

Description

Value

112

Call result

000

NO_ERROR

001

API_GENERIC_ERROR

005

API_NOT_IN_PAUSED_STATE

006

PERMISSIONS_NOT_GRANTED