Skip to main content
POST
/
medical
/
v1
/
identity
/
session
Create Identity Session
curl --request POST \
  --url https://api.sandbox.metriport.com/medical/v1/identity/session \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "patientId": "<string>",
  "redirectUrl": "<string>",
  "metadata": {}
}
'
{
  "sessionId": "<string>",
  "sessionUrl": "<string>",
  "expiresAt": "<string>",
  "status": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://docs.metriport.com/llms.txt

Use this file to discover all available pages before exploring further.

Returns a single-use URL where the user completes IAL2 identity verification with an approved Credential Service Provider. When verification finishes, Metriport sends an ias.identity.verified webhook with a proofedIdentityId you pass on subsequent IAS-purposed queries.

​
Body

​
patientId
string
required
The Metriport patient the verified identity will be attached to.
​
redirectUrl
string
required
HTTPS URL where Metriport sends the user after the session. Must be on your account’s allowlist.
​
metadata
object
Up to 50 string key/value pairs. Returned on subsequent webhook events.

​
Response

​
sessionId
string
required
Unique identifier for this identity session.
​
sessionUrl
string
required
The URL to redirect the user to. Single-use.
​
expiresAt
string
required
ISO-8601 timestamp when the session URL expires.
​
status
string
required
pending on creation. Reaches completed or expired.
Response
{
  "sessionId": "ids_018f7c2f...",
  "sessionUrl": "https://auth.ias.metriport.com/s/eyJhbGciOi...",
  "expiresAt": "2026-04-29T14:52:11.000Z",
  "status": "pending"
}