Skip to main content
POST
/
identity
/
sessions
Create session
curl --request POST \
  --url https://api.txcloud.io/v1/identity/sessions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "document_type": "<string>",
  "country": "<string>",
  "checks": [
    "<string>"
  ],
  "metadata": {}
}
'
{
  "id": "sess_a1b2c3d4e5f6",
  "object": "identity.session",
  "status": "pending",
  "document_type": "<string>",
  "country": "<string>",
  "documents": [
    {
      "side": "<string>",
      "uploaded": true,
      "quality_score": 123
    }
  ],
  "selfie_uploaded": true,
  "expires_at": "2023-11-07T05:31:56Z",
  "created_at": "2023-11-07T05:31:56Z"
}

Authorizations

Authorization
string
header
required

API key as Bearer token

Body

application/json
document_type
string
required
country
string
required
checks
string[]
metadata
object

Response

201 - application/json

Session created

id
string
Example:

"sess_a1b2c3d4e5f6"

object
enum<string>
Available options:
identity.session
status
enum<string>
Available options:
pending,
ready,
completed,
expired
document_type
string
country
string
documents
object[]
selfie_uploaded
boolean
expires_at
string<date-time>
created_at
string<date-time>