> ## Documentation Index
> Fetch the complete documentation index at: https://grandcentral.backbase.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Get started

> Quickstart guide for BioCatch behavioral biometrics integration

Complete the following prerequisites and configuration to integrate the BioCatch Connector.

## Prerequisites

* BioCatch account and API credentials
* Client app with BioCatch JavaScript SDK
* Understanding of fraud detection workflows
* For private hosting, ensure that the IP address of the cluster or the IP address of the root machine server is on the BioCatch allowlist.

## Setup steps

1. Set your APIM subscription key in the header as follows:
   * Key: `api-key`
   * Value: `<your subscription key>`

2. Configure the following details in `gc-applications-live`, in the `values.yaml` file. For example:

   ```text theme={"system"}
   ├── iPaaS
   └── azure/runtimes
       ├── dev-v2
       └── test-v2
           └── values
               ├── gc-biocatch
                   └── fraud-v0.values.yaml
   ```

3. Configure BioCatch credentials in the `values.yaml` file:

   * `customerId`
   * `biocatch.base.url`
   * `biocatch-authorization`
   * `solution`

   The following example shows a sample `values.yaml` file:

   ```properties theme={"system"}
   biocatch.base.url=https://api-bullseyetest.us.v2.customers.biocatch.com/api/v6/score
   retryFlag=true
   customerId=bullseyetest
   solution=ATO
   ```

4. **Install client SDK**
   * Add BioCatch JavaScript to your app
   * Configure session tracking

5. **Configure risk policies**
   * Define risk thresholds
   * Set up alert rules
   * Configure actions

## Test your integration

Test your integration with the BioCatch sandbox environment before deploying to production.

To access the Fraud Unified API, include your Grand Central subscription key in the request header. If you don't have a key, contact the Grand Central Support Team to have one provisioned.

| Key       | Value                     |
| :-------- | :------------------------ |
| `api-key` | `<your_subscription_key>` |

Test the API using the [Postman collection](https://github.com/bb-ecos-ecos/grandcentral-documentation/blob/main/Postman-Collection/GC%20Fraud%20-%20Unified%20Spec.postman_collection.json).

## Troubleshooting

If your connector isn't responding as expected, check these common scenarios.

<AccordionGroup>
  <Accordion icon="lock" title="5xx: internal server error or core system down">
    **Cause:** The Grand Central gateway can't establish a handshake with the BioCatch endpoint. This typically indicates an upstream service outage at BioCatch or a network routing failure.

    **Solution:** Verify the operational status of the BioCatch environment with BioCatch. If the service is operational, contact the [GC Support](mailto:gc_support@backbase.com) team.
  </Accordion>

  <Accordion icon="wifi-slash" title="5xx: timeout or sockettimeoutexception">
    **Cause:** The request to BioCatch exceeded the configured timeout threshold. This can occur during high load or network latency issues.

    **Solution:** Verify the operational status of the BioCatch environment with BioCatch. If the service is operational, contact the [GC Support](mailto:gc_support@backbase.com) team to review timeout configurations.
  </Accordion>

  <Accordion icon="key" title="Invalid authentication">
    **Cause:** The credentials provided during setup are incorrect.

    **Solution:** Verify your credentials with BioCatch and contact the GC team to update the connection.
  </Accordion>

  <Accordion icon="gauge-high" title="429: rate limit exceeded">
    **Cause:** The number of incoming requests exceeded the defined threshold for your subscription tier. This response protects the stability of the Grand Central and partner infrastructure.

    **Solution:** Review your application's request patterns to identify unexpected spikes. If you require higher throughput, contact the Grand Central team to request an adjustment to your APIM rate limit policy.
  </Accordion>
</AccordionGroup>

## Need more help?

<Card icon="envelope" href="mailto:support@grandcentral.io" title="Contact support">
  Reach out to the Grand Central team for assistance with environment setup or rate limit increases.
</Card>