Skip to content

Create identity proof

Request

Create a new identity proof session for person verification within this account. Returns an ID and secure token for subsequent requests.

Security
PartnerApiKey and PartnerOAuth
Path
accountIdinteger, (int64)required
Bodyapplication/jsonrequired
verificationMethodstringrequired

Verification method (EMAIL, SMS, or EMAIL_AND_SMS). Case-insensitive.

Enum:"EMAIL""SMS""EMAIL_AND_SMS"
Example:"EMAIL_AND_SMS"
verificationMethodEnumstring
Enum:"EMAIL""SMS""EMAIL_AND_SMS""PAPER""NULL"
curl -i -X POST \
  'https://api-docs.lobbie.com/_mock/openapi/partner/v2/account/{accountId}/identity-proof' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -d '{
    "verificationMethod": "EMAIL_AND_SMS",
    "verificationMethodEnum": "EMAIL"
  }'

Responses

Identity proof created successfully

Bodyapplication/json
createdAtstring, (date-time)

Creation timestamp (UTC)

Example:"2025-01-15T14:00:00Z"
idinteger, (int64)

Identity proof ID (use this in subsequent requests)

Example:12345
isVerifiedboolean

Whether all required verification methods have been completed

Example:false
tokenstring

Secure token for X-Identity-Token header

Example:"abc123..."
verificationMethodstring

Verification method

Enum:"EMAIL""SMS""EMAIL_AND_SMS""PAPER""NULL"
Example:"EMAIL_AND_SMS"
verifiedEmailstring

Verified email (if verified)

Example:"john@example.com"
verifiedPhonestring

Verified phone (if verified)

Example:"5551234567"
Response
{
  "createdAt": "2025-01-15T14:00:00Z",
  "id": 12345,
  "isVerified": false,
  "token": "abc123...",
  "verificationMethod": "EMAIL_AND_SMS",
  "verifiedEmail": "john@example.com",
  "verifiedPhone": "5551234567"
}