Skip to main content
POST
/
v1
/
consumer
/
inbox
/
deliver
Deliver Credential to Consumer
curl --request POST \
  --url https://api.truthlocks.com/v1/consumer/inbox/deliver \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "attestation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "recipient_email": "jsmith@example.com"
}
'
{
  "status": "delivered",
  "id": "770e8400-e29b-41d4-a716-446655440002"
}
Deliver an attestation to a consumer’s inbox by email. If the consumer exists, the credential is delivered immediately. If the consumer hasn’t signed up yet, the delivery is stored as pending and automatically claimed when they register. Requires issuer (tenant console) authentication.

​
Parameters

​
attestation_id
string
required
UUID of the attestation to deliver
​
consumer_reference
string
required
Consumer’s email address
​
safe_metadata
object
Non-sensitive metadata to display in the inbox (e.g. schema name, issuer name)

​
Responses

{
  "status": "delivered",
  "id": "770e8400-e29b-41d4-a716-446655440002"
}

Authorizations

​
X-API-Key
string
header
required

API key for machine-to-machine authentication

Body

application/json
​
attestation_id
string<uuid>
required
​
recipient_email
string<email>
required

Response

200 - application/json

Delivery queued

​
delivery_id
string<uuid>
​
status
string