> ## 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.

# Getting Started: Your First API Call

This guide will walk you through setting up your environment, authenticating, and making your first successful API call to the FrankieOne platform.

Welcome to the FrankieOne API! This guide provides the essential information to get you up and running. Our goal is to help you make your first successful API call in minutes.

### Your FrankieOne Starter Pack

When you partner with FrankieOne, your Customer Success Manager will provide you with a starter pack containing everything you need for each environment. You should have the following:

| Resource         | UAT / Sandbox                              | Production                         |
| :--------------- | :----------------------------------------- | :--------------------------------- |
| **Portal URL**   | `https://portal.kycaml.uat.frankieone.com` | `https://portal.frankieone.com`    |
| **API Base URL** | `https://api.uat.frankie.one/v2`           | `https://api.frankie.one/v2`       |
| **Customer ID**  | Your unique UAT Customer ID                | Your unique Production Customer ID |
| **API Key**      | Your secret UAT API Key                    | Your secret Production API Key     |

***

## Authentication Headers

All API requests to FrankieOne must be authenticated. You'll use the credentials from your starter pack in the request headers.

| Header                 | Required | Description                                                                                                      |
| :--------------------- | :------- | :--------------------------------------------------------------------------------------------------------------- |
| `api_key`              | **Yes**  | Your secret API key for the specific environment (UAT or Production).                                            |
| `X-Frankie-CustomerID` | **Yes**  | The unique identifier for your account.                                                                          |
| `X-Frankie-Username`   | No       | The email address or identifier of the operator performing the action. Highly recommended for auditing purposes. |
| `X-Frankie-Channel`    | No       | The channel the request originates from (e.g., `API`, `PORTAL`, `ONESDK`). Useful for analytics and routing.     |

<Callout icon="bell" color="#FFCA16" iconType="regular">
  ##### Keep Your API Key Secure

  Your `api_key` is a secret and should be treated like a password. Store it securely on your backend and never expose it in client-side code or public repositories. If you suspect a key has been compromised, contact support immediately.
</Callout>

***

## Quickstart in 3 Steps

Follow these steps to ensure your credentials are correct and your environment is ready for integration.

<Steps>
  <Step title="Test Your Connection" titleSize="h4">
    The easiest way to verify that your credentials and connection are working is to call our simple health check endpoint: `/ruok`. This endpoint doesn’t require a request body and is used purely to confirm successful authentication.

    ```cURL theme={null}
        curl --location '[https://api.uat.frankie.one/v2/kyc/ruok](https://api.uat.frankie.one/v2/kyc/ruok)'
        --header 'api_key: {{your_uat_api_key}}' 
        --header 'X-Frankie-CustomerID: {{your_uat_customer_id}}'  
    ```

    A successful request will return a `200 OK` status and the following JSON response, confirming your keys are valid.

    ```Response theme={null}
        {   
           "status": "OK"  
        }  
    ```
  </Step>

  <Step title="Confirm Your Workflow Setup" titleSize="h4">
    Before you can start verifying customers, your account needs to be configured with at least one workflow and one service profile. Your Customer Success Manager typically sets these up for you.
    You can confirm your setup by calling the `GET /v2/workflows` endpoint. This will list all the executable workflows available to you.

    ```cURL theme={null}
        curl --location '[https://api.uat.frankie.one/v2/workflows](https://api.uat.frankie.one/v2/workflows)'
        --header 'api_key: {{your_uat_api_key}}'
        --header 'X-Frankie-CustomerID: {{your_uat_customer_id}}'  
    ```

    You should receive a `200 OK` response with a `workflows` array. If the array is empty, please contact your Customer Success Manager to get your workflows published.

    ```Response theme={null}
        {  
            "requestId": "req_01J...",  
            "workflows": [  
                {  
                    "serviceName": "DEFAULT",  
                    "workflowId": "wf_01J...",  
                    "workflowName": "Standard-KYC-AU",  
                    "type": "SYSTEM",  
                    "lifecyclePhase": "ONBOARDING"  
                }  
            ]  
        }  
    ```
  </Step>

  <Step title="Make Your First Verification Call" titleSize="h4">
    Now you're ready to perform your first check. The most fundamental call is to create an individual and execute a workflow in a single request. This is the fastest way to verify a new customer.

    You will need the `serviceName` and `workflowName` from the previous step.

    > *For a detailed guide on this process, see our **[Electronic KYC with Government ID](/docs/electronic-kyc-checks)** guide.*
  </Step>
</Steps>

***

## Next Steps

You've successfully authenticated and confirmed your setup.
Now you're ready to start building.
Follow our implementation guides for common use cases.

<CardGroup columns={2}>
  <Card title="Creating & Managing Individuals" href="/docs/managing-individuals" icon="user-plus" iconType="solid">
    Learn the complete lifecycle of an 'individual' entity, from creation and retrieval to updates and deletion.
  </Card>

  <Card title="Executing a Workflow" href="/docs/executing-workflows" icon="play" iconType="solid">
    A step-by-step guide to executing a verification workflow against an existing entity.
  </Card>

  <Card title="API Reference" href="/docs/reference/whats-new" icon="book-open" iconType="solid">
    Dive deep into every endpoint, parameter, and response object in our comprehensive API Reference.
  </Card>
</CardGroup>