Cleared API

const axios = require('axios');

const response = await axios.post(
  'https://cleared.id/api/v1/merchant/identity/verification/initiate',
  {
    name: 'John Smith',
    emailAddress: 'john@example.com',
    phoneNumber: '+18761234567',
    trn: '123-456-789',
    verificationRequests: [
      { type: 'identity', required: true },
      { type: 'address', required: true }
    ],
    expiration: {
      expiresAt: new Date(Date.now() + 48 * 60 * 60 * 1000).toISOString()
    }
  },
  {
    headers: {
      'Authorization': `Bearer ${process.env.CLEARED_API_KEY}`,
      'Content-Type': 'application/json'
    }
  }
);

console.log('Request ID:', response.data.requestId);
console.log('Result ID:', response.data.resultId);

import requests
import os

api_key = os.environ.get('CLEARED_API_KEY')
report_id = 'res_abc123'

response = requests.get(
    f'https://cleared.id/api/v1/merchant/identity/report/{report_id}',
    headers={
        'Authorization': f'Bearer {api_key}',
        'Content-Type': 'application/json'
    }
)

data = response.json()

if data['status'] == 'cleared':
    print(f"Verified: {data['name']}")
    print(f"Tax Number: {data['uniqueIdNumber']}")
    print(f"Document: {data['documentType']}")
else:
    print(f"Status: {data['status']}")

<?php

$apiKey = getenv('CLEARED_API_KEY');
$documentId = 'doc_xyz789';

$data = [
    'signingParties' => [
        [
            'name' => 'John Smith',
            'email' => 'john@example.com',
            'role' => 'Employee',
            'order' => 1,
            'requireIdVerification' => true
        ]
    ],
    'configuration' => [
        'useDigitalSignature' => true,
        'enforceSigningOrder' => false,
        'expiration' => [
            'type' => 'relative',
            'relativeDays' => 30
        ]
    ]
];

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, "https://cleared.id/api/v1/merchant/signatures/documents/$documentId/send");
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($data));
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "Authorization: Bearer $apiKey",
    "Content-Type: application/json"
]);

$response = curl_exec($ch);
curl_close($ch);

$result = json_decode($response, true);
echo "Document sent. Status: " . $result['data']['status'];
?>

curl -X POST https://cleared.id/api/v1/merchant/verification-links/create \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "linkTitle": "Customer Verification",
    "linkId": "customer-kyc",
    "verificationType": "identity",
    "destination": "https://yoursite.com/verification/complete",
    "clientBranding": {
      "companyName": "Your Company",
      "logo": "https://yoursite.com/logo.png"
    },
    "webhookConfig": {
      "url": "https://yourapi.com/webhooks/cleared",
      "secret": "your-webhook-secret"
    }
  }'

# Response:
{
  "success": true,
  "link": {
    "linkId": "customer-kyc",
    "url": "https://cleared.id/v/customer-kyc"
  }
}