Header Parameters
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
curl -X POST "https://example.com/v1/verifications/sms/preview" \ -H "Content-Type: application/json" \ -d '{ "subject_type": "person", "fields": { "property1": "string", "property2": "string" } }'{}Patch Subscription
Update a webhook subscription's target_url, event_types, and/or status. Only fields present in the request body are changed. Setting status="active" resets the consecutive-failure counter, so a subscription that was auto-disabled after 50 straight delivery failures does not immediately re-disable itself.
Put File Upload
Send the file's bytes to an upload link. No Authorization header. Works once. A link already expired when the PUT starts is 410. The body must arrive before the link expires (and within 10 minutes), or 408. Storing it may end after the expiry, up to 15 minutes later. Unknown id, wrong token, a used link, and a file that could not be stored at the end are all 404 with one message: make a new link if the file is not stored. A second upload of the same file is harmless. Empty body: 422. A verification document whose first bytes are not the declared JPEG, PNG or PDF: 422.