Skip to content

Quick Start Guide

Get started with Biometrid API in minutes. This guide will walk you through creating your first identity verification process.

Before You Begin

You'll need:

  • Biometrid account at admin.biometrid.com
  • Your API credentials (app ID and credential ID)
  • A configured flow in your account

Step 1: Get Your Credentials

  1. Go to admin.biometrid.com
  2. Navigate to Integration > Applications to get your biometrid-app ID
  3. Navigate to Integration > Credentials to get your biometrid-credential ID

Keep these credentials secure and never expose them in client-side code.

Step 2: Initialize Your Account

First, let's verify your credentials and get account information:

curl -X GET "https://api.biometrid.com/accounts/init" \
  -H "biometrid-app: YOUR_APP_ID" \
  -H "biometrid-credential: YOUR_CREDENTIAL_ID" \
  -H "Content-Type: application/json"

Expected Response:

{
  "data": {
    "account": {
      "id": "account_id",
      "name": "Your Account Name",
      "language": "en"
    },
    "system": {
      "fileMaxSize": 5,
      "rtmUrl": "https://api.biometrid.com"
    }
  },
  "status": true
}

Step 3: Create a New Process

Create a new identity verification process:

curl -X POST "https://api.biometrid.com/processes" \
  -H "biometrid-app: YOUR_APP_ID" \
  -H "biometrid-credential: YOUR_CREDENTIAL_ID" \
  -H "Content-Type: application/json" \
  -d '{
    "reference": "user_12345"
  }'

Expected Response:

{
  "data": {
    "processId": "process_abc123",
    "flowId": "flow_456",
    "step": {
      "id": "step_1",
      "name": "Personal Information",
      "action": {
        "type": "form",
        "fields": [
          {
            "type": "input",
            "id": "name",
            "label": "Full Name"
          },
          {
            "type": "email",
            "id": "email",
            "label": "Email Address"
          }
        ]
      }
    }
  },
  "status": true
}

Step 4: Submit Step Data

Submit data for the current step:

curl -X POST "https://api.biometrid.com/processes/process_abc123/step" \
  -H "biometrid-app: YOUR_APP_ID" \
  -H "biometrid-credential: YOUR_CREDENTIAL_ID" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "John Doe",
    "email": "john@example.com"
  }'

Step 5: Check Current Step

Get the current step information:

curl -X GET "https://api.biometrid.com/processes/process_abc123/step" \
  -H "biometrid-app: YOUR_APP_ID" \
  -H "biometrid-credential: YOUR_CREDENTIAL_ID" \
  -H "Content-Type: application/json"

Common Step Types

Form Step

{
  "name": "John Doe",
  "email": "john@example.com",
  "phone": {
    "country": "PT",
    "number": "123456789"
  }
}

Document Upload Step

{
  "doctype": "idcard",
  "front": "base64-encoded-image-data",
  "back": "base64-encoded-image-data"
}

Face Liveness Step

{
  "photo": "base64-encoded-image-data"
}

OTP Verification Step

{
  "otpCode": "123456"
}

Step 6: Set Up Webhooks (Optional)

Configure webhooks to receive real-time notifications:

  1. Go to admin.biometrid.com
  2. Navigate to Flows > Edit Flow > Add Notifications
  3. Add your webhook URL
  4. Select events to receive:
  5. process:created
  6. process:updated
  7. process:status

Complete Flow Example

Here's a complete example of a typical verification flow:

# 1. Create process
PROCESS_ID=$(curl -X POST "https://api.biometrid.com/processes" \
  -H "biometrid-app: YOUR_APP_ID" \
  -H "biometrid-credential: YOUR_CREDENTIAL_ID" \
  -H "Content-Type: application/json" \
  -d '{"reference": "user_12345"}' | jq -r '.data.processId')

# 2. Submit personal info
curl -X POST "https://api.biometrid.com/processes/$PROCESS_ID/step" \
  -H "biometrid-app: YOUR_APP_ID" \
  -H "biometrid-credential: YOUR_CREDENTIAL_ID" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "John Doe",
    "email": "john@example.com"
  }'

# 3. Check next step
curl -X GET "https://api.biometrid.com/processes/$PROCESS_ID/step" \
  -H "biometrid-app: YOUR_APP_ID" \
  -H "biometrid-credential: YOUR_CREDENTIAL_ID" \
  -H "Content-Type: application/json"

Next Steps

Need Help?

  • Documentation: Browse our complete API Documentation
  • Support: Contact support through the admin panel
  • Status: Check API status at our status page

Security Best Practices

  1. Never expose credentials in client-side code
  2. Use HTTPS for all API calls
  3. Implement proper error handling
  4. Validate webhook signatures
  5. Follow rate limiting guidelines

Pro Tip: Use the process reference field to link processes with your internal user IDs for easier tracking.