Skip to main content
POST
/
kyc
/
session
Create a KYC session
curl --request POST \
  --url https://api.salesive.com/api/v1/kyc/session \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "callbackUrl": "https://app.example.com/kyc/callback"
}
'
{
  "status": 200,
  "success": true,
  "message": "KYC session created",
  "data": {
    "sessionId": "sess_abc123",
    "sessionUrl": "https://verification.didit.me/session/sess_abc123",
    "status": "pending"
  }
}
Starts a new verification session (or returns the active one) and gives you a session id and verification URL to redirect the merchant to. The store is bound to your app token server-side — never send a shop id.

Authorizations

​
Authorization
string
header
required

Installed-app access token (prefix app_), issued by the OAuth install flow. The store is bound to the token server-side — never send a shop id.

Body

application/json
​
callbackUrl
string<uri>
required

URL the merchant is returned to after completing verification.

Response

The verification session (newly created or resumed).

Standard Salesive response envelope. The operation-specific payload is carried in data.

​
status
integer
required

HTTP status code, echoed in the body.

​
success
boolean
required

Whether the request succeeded.

​
message
string
required

Human-readable result message.

​
data
object

A verification session returned by create-session. When the store is already verified, alreadyApproved is true and the session fields may be omitted.