Skip to main content
POST
curl

Authorizations

API-Key
string
header
required

Your public API key. Identifies the partner making the request.

API-Nonce
string
header
required

Monotonically increasing nonce included in the request signature.

API-Sign
string
header
required

HMAC signature over the request, computed with your private key.

Path Parameters

user_id
string
required

ID of the user the request applies to. For partners operating in the B2B2C model, this is the Sub-User the request is acting on behalf of. Canonical identifier for a user in the Payward public API.

Required string length: 14 - 42
verification_id
string
required

Public PV-prefixed verification ID. Public identifier for a Payward-managed verification.

Required string length: 20
Pattern: ^PV[A-Z0-9]{5}-[A-Z0-9]{5}-[A-Z0-9]{6}$
Example:

"PVABCDE-FGHIJ-KLMNOP"

Response

Hosted verification resumed.

data
object
required

Fields used to launch the hosted verification UI.