Skip to main content
GET
/
api
/
platform
/
persona
/
platform-user
/
inquiry
/
{user_id}
Create or resume a Persona inquiry for a platform user
curl --request GET \
  --url http://localhost:8001/api/platform/persona/platform-user/inquiry/{user_id} \
  --header 'X-Platform-ID: <x-platform-id>' \
  --header 'X-Signature: <x-signature>'
{
  "success": true,
  "message": "Operation completed.",
  "data": {
    "inquiry_url": "https://withpersona.com/verify?inquiry-id=inq_uRe3YX5eytvZGpJhMefHB5saWxXe",
    "is_kyc_pending": true
  },
  "queryGeneratedTime": 1718006400
}

Headers

​
X-Platform-ID
string<uuid>
required

Unique platform identifier (UUID). You receive this during onboarding. Must be sent with every API request.

​
X-Signature
string
required

HMAC-SHA256 request signature for authentication. Use your platform secret key to compute it as: METHOD + PATH + QUERY + BODY_HASH.

Path Parameters

​
user_id
string<uuid>
required

Unique identifier (UUID) of the user for whom KYC verification is being initiated or resumed.

Response

Successful Response

​
success
boolean
default:true

Indicates whether the request was processed successfully.

Example:

true

​
message
string
default:Success

A short, human-readable message describing the result of the request.

Example:

"Operation completed."

​
data
PlatformInquiryPayload · object

The main response payload, if applicable

​
queryGeneratedTime
number | null
default:1782303609.673092

The Unix timestamp (in seconds) indicating when the response was generated.

Example:

1718006400