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

# Working with the Sandbox

> Learn how to use our sandbox environment for safe API testing without affecting production data

<Info>
  The sandbox environment is your safe space to test and validate API integrations before going live. All operations performed here are isolated from production data.
</Info>

## Accessing the Sandbox

<Steps>
  <Step title="Request Access">
    Contact our sales team to get sandbox access as part of the onboarding process.
  </Step>

  <Step title="Receive Credentials">
    You'll get a welcome pack containing:

    * API access keys
    * Code examples
    * Test data sets
  </Step>

  <Step title="Additional Services (Optional)">
    Let us know if you need access to:

    * Portal services
    * IDV (Identity Verification) services
  </Step>
</Steps>

## Testing Guidelines

<AccordionGroup>
  <Accordion title="Test Data Matching Rules">
    * Family name matching is the primary identifier
    * Matching is case-insensitive
    * Use middle name "`passall`" to force a successful match
  </Accordion>

  <Accordion title="Special Test Cases">
    The test data includes special markers that trigger specific responses:

    ```plaintext theme={null}
    CLEAR    -> Clean record
    PEP      -> Politically Exposed Person
    SANCTION -> Sanctions list match
    FRAUD    -> Fraud indicators present
    SKIP     -> Uses external test service with detailed response
    ```
  </Accordion>
</AccordionGroup>

## Available Entity Profiles

<Callout icon="thumbtack" color="#1A6CFF" iconType="regular">
  Entity profiles determine the combination of checks performed during verification. Choose based on your regulatory requirements and jurisdiction.
</Callout>

<Tabs>
  <Tab title="Basic Profiles">
    | Profile        | Check Types                              | Description                                        |
    | -------------- | ---------------------------------------- | -------------------------------------------------- |
    | `default`      | `two_plus,id,pep_media,idvalidate`       | Standard verification suite                        |
    | `gov_id`       | `blacklist,id_only,pep,idvalidate`       | Government ID focused checks                       |
    | `gov_id_media` | `blacklist,id_only,pep_media,idvalidate` | Enhanced government ID checks with media screening |
  </Tab>

  <Tab title="Safe Harbor Profiles">
    | Profile                   | Check Types                                       | Description                                                          |
    | ------------------------- | ------------------------------------------------- | -------------------------------------------------------------------- |
    | `safe_harbour`            | `blacklist,two_plus,pep,idvalidate`               | Comprehensive KYC checks                                             |
    | `safe_harbour_media`      | `blacklist,two_plus,pep_media,idvalidate`         | Enhanced KYC with media screening                                    |
    | `safe_harbour_id`         | `blacklist,two_plus,id,pep,idvalidate`            | Full KYC with government ID                                          |
    | `safe_harbour_id_media`   | `blacklist,two_plus,id,pep_media,idvalidate`      | Complete KYC suite with media screening                              |
    | `safe_harbour_plus`       | `blacklist,two_plus_both,id,pep,idvalidate`       | Enhanced KYC with mandatory address verification (e.g., New Zealand) |
    | `safe_harbour_plus_media` | `blacklist,two_plus_both,id,pep_media,idvalidate` | Complete KYC suite with mandatory address and media screening        |
  </Tab>

  <Tab title="KYB Profiles">
    | Profile        | Check Types | Description                                 |
    | -------------- | ----------- | ------------------------------------------- |
    | `beneficiary`  | `pep_media` | Beneficial owner screening and verification |
    | `organisation` | `pep_media` | Business entity verification and screening  |
  </Tab>

  <Tab title="International Profiles">
    | Profile               | Check Types                                  | Description                                     |
    | --------------------- | -------------------------------------------- | ----------------------------------------------- |
    | `international`       | `blacklist,one_plus,id,pep,idvalidate`       | International verification suite                |
    | `international_media` | `blacklist,one_plus,id,pep_media,idvalidate` | International verification with media screening |
  </Tab>
</Tabs>

<Info>
  ##### Profile Selection

  * KYC profiles are designed for individual verification
  * KYB profiles are specifically for business-related verifications
  * Safe Harbor Plus profiles are required for jurisdictions with mandatory address verification (e.g., New Zealand)
</Info>

## Testing Error Scenarios

<CardGroup cols={2}>
  <Card title="Credit Header Failures" icon="triangle-exclamation">
    Set street address to either:

    * "Equifax"
    * "Experian"

    This forces a credit header failure for the specified bureau.
  </Card>

  <Card title="Non-ID Check Failures" icon="id-card">
    Set middle name to "FailNonID" to:

    * Force fail all non-ID checks
    * Only evaluate ID verification

    <Callout icon="bell" color="#FFCA16" iconType="regular">
      Ensure ID-related details (name, DoB, ID numbers) are correct for proper testing.
    </Callout>
  </Card>
</CardGroup>

<Info title="Data Source Note">
  All data sources in the sandbox environment are stubbed and may return randomized source information for testing purposes.
</Info>