Skip to main content
POST
/
partner
/
browser-session
Create browser session
curl --request POST \
  --url https://app.cr3dentials.xyz/v1/partner/browser-session \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "platformId": 1,
  "receiverData": {
    "name": "John Doe",
    "email": "john@example.com"
  },
  "expiresInHours": 24,
  "country": "US",
  "webhookUrl": "https://your-app.com/webhooks/cr3dentials",
  "externalReferenceId": "user_abc123"
}
'
{
  "status": "success",
  "data": {
    "sessionId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "embedUrl": "https://frame.cr3dentials.xyz/verify/a1b2c3d4...?token=xxx",
    "platformId": 1,
    "expiresAt": "2023-11-07T05:31:56Z",
    "createdAt": "2023-11-07T05:31:56Z",
    "externalReferenceId": "user_abc123"
  }
}

Authorizations

​
x-api-key
string
header
required

Your partner API key. Alternatively, pass Authorization: Bearer <key>.

Body

application/json
​
platformId
integer
required

Platform ID from the platforms endpoint.

Example:

1

​
receiverData
object

Metadata about the person performing verification (name, email, phone, etc.).

Example:
{
  "name": "John Doe",
  "email": "john@example.com"
}
​
expiresInHours
integer

Session TTL in hours (1–168). Defaults to the maximum if omitted.

Required range: 1 <= x <= 168
Example:

24

​
country
enum<string>

Proxy exit country for the verification browser session. When set, the session routes through a residential proxy in this country and the closest Hyperbrowser region is selected automatically, overriding the default URL-based geo selection.

Available options:
US,
IN,
DE,
GB,
JP,
SG,
AU,
BR
Example:

"US"

​
webhookUrl
string<uri>

HTTPS URL to receive session status webhooks. Must use HTTPS with a valid TLD.

Example:

"https://your-app.com/webhooks/cr3dentials"

​
externalReferenceId
string

Your internal reference ID for tracking this session. Included in webhook payloads and responses.

Example:

"user_abc123"

Response

Session created

​
status
string
Example:

"success"

​
data
object