Getting Started: Your First API Call

1. Test Your Connection

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 --location '[https://api.uat.frankieone.com/v2/ruok](https://api.uat.frankieone.com/v2/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.

1
{
2
  "status": "OK"
3
}

If you receive an error, double-check that your API key and Customer ID are correct and that you are using the correct base URL for the environment.

2. Confirm Your Workflow Setup

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 --location '[https://api.uat.frankieone.com/v2/workflows](https://api.uat.frankieone.com/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.

1
{
2
    "requestId": "req_01J...",
3
    "workflows": [
4
        {
5
            "serviceName": "KYC",
6
            "workflowId": "wf_01J...",
7
            "workflowName": "Standard-KYC-AU",
8
            "type": "SYSTEM",
9
            "lifecyclePhase": "ONBOARDING"
10
        }
11
    ]
12
}

3. Make Your First Verification Call

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