Create Verification Request
Create a new income verification request. An email will be sent to the tenant with a secure link to complete verification.
Create Verification
POST
/verifyRequest Body
| Parameter | Type | Required | Description |
|---|---|---|---|
| tenant_email | string | Yes | Tenant's email address |
| tenant_name | string | No | Tenant's full name |
| tenant_phone | string | No | Tenant's phone number |
| property_address | string | No | Property address for verification |
| monthly_rent | number | No | Monthly rent for affordability calculation |
| webhook_url | string | No | URL to receive webhook notifications |
Example Request
curl -X POST https://tenantverify.org/api/v1/verify \
-H "Authorization: Bearer tv_live_your_api_key" \
-H "Content-Type: application/json" \
-d '{
"tenant_email": "tenant@example.com",
"tenant_name": "John Doe",
"property_address": "123 Main St, Apt 4B",
"monthly_rent": 2000,
"webhook_url": "https://your-app.com/webhooks/tenantverify"
}'Response (201 Created)
{
"success": true,
"data": {
"verification_id": "550e8400-e29b-41d4-a716-446655440000",
"verification_url": "https://tenantverify.org/verify/abc123xyz",
"tenant_email": "tenant@example.com",
"status": "pending",
"expires_at": "2024-01-30T00:00:00.000Z"
}
}