curl
curl -X POST "https://api.sandbox.services.payward.com/v1/users/AA45N8G4MLDYWAR7/verifications/evidence" \
-H "API-Key: $PWS_API_KEY" \
-H "API-Timestamp: $PWS_API_TIMESTAMP" \
-H "API-Sign: $PWS_API_SIGN" \
-H "Idempotency-Key: 550e8400-e29b-41d4-a716-446655440000" \
-H "Content-Type: application/json" \
-d '{
"type": "identity_document",
"document": {
"type": "passport",
"number": "X12345678",
"issuing_country": "US",
"front": {
"https_url": "https://your-allowlisted-bucket.s3.amazonaws.com/passport.jpg"
}
},
"partner_result": {
"verifier": "partner-verifier",
"completed_at": "2026-09-21T10:00:00Z",
"response": {
"status": "approved"
}
}
}'import requests
url = "https://api.sandbox.services.payward.com/v1/users/{user_id}/verifications/evidence"
payload = {
"type": "identity_document",
"document": {
"type": "passport",
"number": "X12345678",
"issuing_country": "US",
"front": { "https_url": "https://your-allowlisted-bucket.s3.amazonaws.com/passport.jpg" }
},
"partner_result": {
"verifier": "partner-verifier",
"completed_at": "2026-09-21T10:00:00Z",
"response": { "status": "approved" }
}
}
headers = {
"Idempotency-Key": "<idempotency-key>",
"API-Key": "<api-key>",
"API-Sign": "<api-key>",
"API-Timestamp": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'Idempotency-Key': '<idempotency-key>',
'API-Key': '<api-key>',
'API-Sign': '<api-key>',
'API-Timestamp': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
type: 'identity_document',
document: {
type: 'passport',
number: 'X12345678',
issuing_country: 'US',
front: {https_url: 'https://your-allowlisted-bucket.s3.amazonaws.com/passport.jpg'}
},
partner_result: {
verifier: 'partner-verifier',
completed_at: '2026-09-21T10:00:00Z',
response: {status: 'approved'}
}
})
};
fetch('https://api.sandbox.services.payward.com/v1/users/{user_id}/verifications/evidence', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.sandbox.services.payward.com/v1/users/{user_id}/verifications/evidence",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'type' => 'identity_document',
'document' => [
'type' => 'passport',
'number' => 'X12345678',
'issuing_country' => 'US',
'front' => [
'https_url' => 'https://your-allowlisted-bucket.s3.amazonaws.com/passport.jpg'
]
],
'partner_result' => [
'verifier' => 'partner-verifier',
'completed_at' => '2026-09-21T10:00:00Z',
'response' => [
'status' => 'approved'
]
]
]),
CURLOPT_HTTPHEADER => [
"API-Key: <api-key>",
"API-Sign: <api-key>",
"API-Timestamp: <api-key>",
"Content-Type: application/json",
"Idempotency-Key: <idempotency-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.sandbox.services.payward.com/v1/users/{user_id}/verifications/evidence"
payload := strings.NewReader("{\n \"type\": \"identity_document\",\n \"document\": {\n \"type\": \"passport\",\n \"number\": \"X12345678\",\n \"issuing_country\": \"US\",\n \"front\": {\n \"https_url\": \"https://your-allowlisted-bucket.s3.amazonaws.com/passport.jpg\"\n }\n },\n \"partner_result\": {\n \"verifier\": \"partner-verifier\",\n \"completed_at\": \"2026-09-21T10:00:00Z\",\n \"response\": {\n \"status\": \"approved\"\n }\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Idempotency-Key", "<idempotency-key>")
req.Header.Add("API-Key", "<api-key>")
req.Header.Add("API-Sign", "<api-key>")
req.Header.Add("API-Timestamp", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.sandbox.services.payward.com/v1/users/{user_id}/verifications/evidence")
.header("Idempotency-Key", "<idempotency-key>")
.header("API-Key", "<api-key>")
.header("API-Sign", "<api-key>")
.header("API-Timestamp", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"type\": \"identity_document\",\n \"document\": {\n \"type\": \"passport\",\n \"number\": \"X12345678\",\n \"issuing_country\": \"US\",\n \"front\": {\n \"https_url\": \"https://your-allowlisted-bucket.s3.amazonaws.com/passport.jpg\"\n }\n },\n \"partner_result\": {\n \"verifier\": \"partner-verifier\",\n \"completed_at\": \"2026-09-21T10:00:00Z\",\n \"response\": {\n \"status\": \"approved\"\n }\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.sandbox.services.payward.com/v1/users/{user_id}/verifications/evidence")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Idempotency-Key"] = '<idempotency-key>'
request["API-Key"] = '<api-key>'
request["API-Sign"] = '<api-key>'
request["API-Timestamp"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"type\": \"identity_document\",\n \"document\": {\n \"type\": \"passport\",\n \"number\": \"X12345678\",\n \"issuing_country\": \"US\",\n \"front\": {\n \"https_url\": \"https://your-allowlisted-bucket.s3.amazonaws.com/passport.jpg\"\n }\n },\n \"partner_result\": {\n \"verifier\": \"partner-verifier\",\n \"completed_at\": \"2026-09-21T10:00:00Z\",\n \"response\": {\n \"status\": \"approved\"\n }\n }\n}"
response = http.request(request)
puts response.read_body{
"data": {
"verification_id": "PVABCDE-FGHIJ-KLMNOP",
"status": "started"
}
}
Verifications
Submit verification evidence
Submit identity documents, residence documents, selfies, or liveness videos already verified by your provider. This endpoint is available only to approved partners. Provide each file through an HTTPS URL on an approved domain.
Include the verifier provenance in partner_result. Identity-document submissions must also include the original verifier response through either response or response_file; residence-document and selfie submissions may omit it. Use response_file for reports whose compact JSON representation exceeds 1 MiB (1,048,576 bytes). The user’s identity and residence country come from their verification profile.
Reuse the same Idempotency-Key only when retrying the same submission. Reusing a key with a different submission is rejected. A successful response includes the verification identifier and its current lifecycle status. Follow verification status and webhook notifications for subsequent changes.
POST
/
v1
/
users
/
{user_id}
/
verifications
/
evidence
curl
curl -X POST "https://api.sandbox.services.payward.com/v1/users/AA45N8G4MLDYWAR7/verifications/evidence" \
-H "API-Key: $PWS_API_KEY" \
-H "API-Timestamp: $PWS_API_TIMESTAMP" \
-H "API-Sign: $PWS_API_SIGN" \
-H "Idempotency-Key: 550e8400-e29b-41d4-a716-446655440000" \
-H "Content-Type: application/json" \
-d '{
"type": "identity_document",
"document": {
"type": "passport",
"number": "X12345678",
"issuing_country": "US",
"front": {
"https_url": "https://your-allowlisted-bucket.s3.amazonaws.com/passport.jpg"
}
},
"partner_result": {
"verifier": "partner-verifier",
"completed_at": "2026-09-21T10:00:00Z",
"response": {
"status": "approved"
}
}
}'import requests
url = "https://api.sandbox.services.payward.com/v1/users/{user_id}/verifications/evidence"
payload = {
"type": "identity_document",
"document": {
"type": "passport",
"number": "X12345678",
"issuing_country": "US",
"front": { "https_url": "https://your-allowlisted-bucket.s3.amazonaws.com/passport.jpg" }
},
"partner_result": {
"verifier": "partner-verifier",
"completed_at": "2026-09-21T10:00:00Z",
"response": { "status": "approved" }
}
}
headers = {
"Idempotency-Key": "<idempotency-key>",
"API-Key": "<api-key>",
"API-Sign": "<api-key>",
"API-Timestamp": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'Idempotency-Key': '<idempotency-key>',
'API-Key': '<api-key>',
'API-Sign': '<api-key>',
'API-Timestamp': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
type: 'identity_document',
document: {
type: 'passport',
number: 'X12345678',
issuing_country: 'US',
front: {https_url: 'https://your-allowlisted-bucket.s3.amazonaws.com/passport.jpg'}
},
partner_result: {
verifier: 'partner-verifier',
completed_at: '2026-09-21T10:00:00Z',
response: {status: 'approved'}
}
})
};
fetch('https://api.sandbox.services.payward.com/v1/users/{user_id}/verifications/evidence', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.sandbox.services.payward.com/v1/users/{user_id}/verifications/evidence",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'type' => 'identity_document',
'document' => [
'type' => 'passport',
'number' => 'X12345678',
'issuing_country' => 'US',
'front' => [
'https_url' => 'https://your-allowlisted-bucket.s3.amazonaws.com/passport.jpg'
]
],
'partner_result' => [
'verifier' => 'partner-verifier',
'completed_at' => '2026-09-21T10:00:00Z',
'response' => [
'status' => 'approved'
]
]
]),
CURLOPT_HTTPHEADER => [
"API-Key: <api-key>",
"API-Sign: <api-key>",
"API-Timestamp: <api-key>",
"Content-Type: application/json",
"Idempotency-Key: <idempotency-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.sandbox.services.payward.com/v1/users/{user_id}/verifications/evidence"
payload := strings.NewReader("{\n \"type\": \"identity_document\",\n \"document\": {\n \"type\": \"passport\",\n \"number\": \"X12345678\",\n \"issuing_country\": \"US\",\n \"front\": {\n \"https_url\": \"https://your-allowlisted-bucket.s3.amazonaws.com/passport.jpg\"\n }\n },\n \"partner_result\": {\n \"verifier\": \"partner-verifier\",\n \"completed_at\": \"2026-09-21T10:00:00Z\",\n \"response\": {\n \"status\": \"approved\"\n }\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Idempotency-Key", "<idempotency-key>")
req.Header.Add("API-Key", "<api-key>")
req.Header.Add("API-Sign", "<api-key>")
req.Header.Add("API-Timestamp", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.sandbox.services.payward.com/v1/users/{user_id}/verifications/evidence")
.header("Idempotency-Key", "<idempotency-key>")
.header("API-Key", "<api-key>")
.header("API-Sign", "<api-key>")
.header("API-Timestamp", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"type\": \"identity_document\",\n \"document\": {\n \"type\": \"passport\",\n \"number\": \"X12345678\",\n \"issuing_country\": \"US\",\n \"front\": {\n \"https_url\": \"https://your-allowlisted-bucket.s3.amazonaws.com/passport.jpg\"\n }\n },\n \"partner_result\": {\n \"verifier\": \"partner-verifier\",\n \"completed_at\": \"2026-09-21T10:00:00Z\",\n \"response\": {\n \"status\": \"approved\"\n }\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.sandbox.services.payward.com/v1/users/{user_id}/verifications/evidence")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Idempotency-Key"] = '<idempotency-key>'
request["API-Key"] = '<api-key>'
request["API-Sign"] = '<api-key>'
request["API-Timestamp"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"type\": \"identity_document\",\n \"document\": {\n \"type\": \"passport\",\n \"number\": \"X12345678\",\n \"issuing_country\": \"US\",\n \"front\": {\n \"https_url\": \"https://your-allowlisted-bucket.s3.amazonaws.com/passport.jpg\"\n }\n },\n \"partner_result\": {\n \"verifier\": \"partner-verifier\",\n \"completed_at\": \"2026-09-21T10:00:00Z\",\n \"response\": {\n \"status\": \"approved\"\n }\n }\n}"
response = http.request(request)
puts response.read_body{
"data": {
"verification_id": "PVABCDE-FGHIJ-KLMNOP",
"status": "started"
}
}
Authorizations
Your public API key. Identifies the partner making the request.
HMAC signature over the request, computed with your private key.
Time the request was signed, as Unix milliseconds. Included in the request signature. Requests signed too far from the server's time are rejected.
Headers
Client-generated canonical UUIDv4 that uniquely identifies a request for safe retries.
Pattern:
^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$Example:
"550e8400-e29b-41d4-a716-446655440000"
Path Parameters
Globally unique public identifier for a user.
Required string length:
14 - 42Body
application/json
- Identity document
- Residence document
- Selfie
Evidence of a check already completed by the partner's verifier.
Selects an identity-document submission.
Available options:
identity_document Identity document and the images supporting the completed check.
Show child attributes
Show child attributes
Provenance of the partner's identity-document check. Exactly one of response or response_file is required.
Show child attributes
Show child attributes
Response
Verification started.
Identifier and current lifecycle status of an accepted partner-managed document submission.
Show child attributes
Show child attributes