Record a credential presentation event (e.g. credential.presented to Stripe)
curl --request POST \
--url https://api.example.com/v1/audit/events \
--header 'Content-Type: application/json' \
--data '
{
"event_type": "credential.presented",
"credential_id": "<string>",
"external_verifier_id": "<string>",
"external_transaction_ref": "<string>",
"external_session_ref": "<string>",
"presented_claims": [
"<string>"
],
"correlation_id": "<string>",
"ucp_checkout_id": "<string>"
}
'import requests
url = "https://api.example.com/v1/audit/events"
payload = {
"event_type": "credential.presented",
"credential_id": "<string>",
"external_verifier_id": "<string>",
"external_transaction_ref": "<string>",
"external_session_ref": "<string>",
"presented_claims": ["<string>"],
"correlation_id": "<string>",
"ucp_checkout_id": "<string>"
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
event_type: 'credential.presented',
credential_id: '<string>',
external_verifier_id: '<string>',
external_transaction_ref: '<string>',
external_session_ref: '<string>',
presented_claims: ['<string>'],
correlation_id: '<string>',
ucp_checkout_id: '<string>'
})
};
fetch('https://api.example.com/v1/audit/events', 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.example.com/v1/audit/events",
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([
'event_type' => 'credential.presented',
'credential_id' => '<string>',
'external_verifier_id' => '<string>',
'external_transaction_ref' => '<string>',
'external_session_ref' => '<string>',
'presented_claims' => [
'<string>'
],
'correlation_id' => '<string>',
'ucp_checkout_id' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$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.example.com/v1/audit/events"
payload := strings.NewReader("{\n \"event_type\": \"credential.presented\",\n \"credential_id\": \"<string>\",\n \"external_verifier_id\": \"<string>\",\n \"external_transaction_ref\": \"<string>\",\n \"external_session_ref\": \"<string>\",\n \"presented_claims\": [\n \"<string>\"\n ],\n \"correlation_id\": \"<string>\",\n \"ucp_checkout_id\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
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.example.com/v1/audit/events")
.header("Content-Type", "application/json")
.body("{\n \"event_type\": \"credential.presented\",\n \"credential_id\": \"<string>\",\n \"external_verifier_id\": \"<string>\",\n \"external_transaction_ref\": \"<string>\",\n \"external_session_ref\": \"<string>\",\n \"presented_claims\": [\n \"<string>\"\n ],\n \"correlation_id\": \"<string>\",\n \"ucp_checkout_id\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/audit/events")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"event_type\": \"credential.presented\",\n \"credential_id\": \"<string>\",\n \"external_verifier_id\": \"<string>\",\n \"external_transaction_ref\": \"<string>\",\n \"external_session_ref\": \"<string>\",\n \"presented_claims\": [\n \"<string>\"\n ],\n \"correlation_id\": \"<string>\",\n \"ucp_checkout_id\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"recorded": true
}Credentials API
Record an Audit Event
POST
/
v1
/
audit
/
events
Record a credential presentation event (e.g. credential.presented to Stripe)
curl --request POST \
--url https://api.example.com/v1/audit/events \
--header 'Content-Type: application/json' \
--data '
{
"event_type": "credential.presented",
"credential_id": "<string>",
"external_verifier_id": "<string>",
"external_transaction_ref": "<string>",
"external_session_ref": "<string>",
"presented_claims": [
"<string>"
],
"correlation_id": "<string>",
"ucp_checkout_id": "<string>"
}
'import requests
url = "https://api.example.com/v1/audit/events"
payload = {
"event_type": "credential.presented",
"credential_id": "<string>",
"external_verifier_id": "<string>",
"external_transaction_ref": "<string>",
"external_session_ref": "<string>",
"presented_claims": ["<string>"],
"correlation_id": "<string>",
"ucp_checkout_id": "<string>"
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
event_type: 'credential.presented',
credential_id: '<string>',
external_verifier_id: '<string>',
external_transaction_ref: '<string>',
external_session_ref: '<string>',
presented_claims: ['<string>'],
correlation_id: '<string>',
ucp_checkout_id: '<string>'
})
};
fetch('https://api.example.com/v1/audit/events', 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.example.com/v1/audit/events",
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([
'event_type' => 'credential.presented',
'credential_id' => '<string>',
'external_verifier_id' => '<string>',
'external_transaction_ref' => '<string>',
'external_session_ref' => '<string>',
'presented_claims' => [
'<string>'
],
'correlation_id' => '<string>',
'ucp_checkout_id' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$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.example.com/v1/audit/events"
payload := strings.NewReader("{\n \"event_type\": \"credential.presented\",\n \"credential_id\": \"<string>\",\n \"external_verifier_id\": \"<string>\",\n \"external_transaction_ref\": \"<string>\",\n \"external_session_ref\": \"<string>\",\n \"presented_claims\": [\n \"<string>\"\n ],\n \"correlation_id\": \"<string>\",\n \"ucp_checkout_id\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
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.example.com/v1/audit/events")
.header("Content-Type", "application/json")
.body("{\n \"event_type\": \"credential.presented\",\n \"credential_id\": \"<string>\",\n \"external_verifier_id\": \"<string>\",\n \"external_transaction_ref\": \"<string>\",\n \"external_session_ref\": \"<string>\",\n \"presented_claims\": [\n \"<string>\"\n ],\n \"correlation_id\": \"<string>\",\n \"ucp_checkout_id\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/audit/events")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"event_type\": \"credential.presented\",\n \"credential_id\": \"<string>\",\n \"external_verifier_id\": \"<string>\",\n \"external_transaction_ref\": \"<string>\",\n \"external_session_ref\": \"<string>\",\n \"presented_claims\": [\n \"<string>\"\n ],\n \"correlation_id\": \"<string>\",\n \"ucp_checkout_id\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"recorded": true
}Body
application/json
Available options:
credential.presented Minimum string length:
1Minimum string length:
1Response
201 - application/json
Audit event recorded
Was this page helpful?
⌘I