Skip to content
registration-links

Create a shareable registration link

POST
/v1/links/create
curl --request POST \
--url https://aggregator.example.com/v1/links/create \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "domain": "example", "slug": "example", "context": {}, "status": "draft", "registration_mode": "example", "expires_at": "2026-04-15T12:00:00Z" }'

Creates a QR / shareable registration link for the caller aggregator, scoped to a domain (seeker/provider). domain and registration_mode are validated against the active network config at request time. Drafts are metadata-only; status=live also mints the QR + public URL.

Media typeapplication/json
object
domain
required
string
>= 1 characters
slug
string
>= 3 characters <= 60 characters /^[a-z0-9]+(?:-[a-z0-9]+)*$/
context
object
key
additional properties
status
string
default: draft
Allowed values: draft live
registration_mode
string
/^[a-z][a-z0-9_]*$/
expires_at
string format: date-time
nullable

Default Response

Media typeapplication/json
object
link_id
required
string
slug
required
string
domain
required
string
status
required
string
registration_mode
required
string
context
required
object
key
additional properties
expires_at
required
string
nullable
public_url
required
string
nullable
qr_url
required
string
nullable
qr_expires_at
required
string
nullable
metrics
required
object
total
required
number
passed
required
number
failed
required
number
skipped
required
number
key
additional properties
any
created_at
required
string
updated_at
required
string
key
additional properties
any
Examplegenerated
{
"link_id": "example",
"slug": "example",
"domain": "example",
"status": "example",
"registration_mode": "example",
"context": {
"additionalProperty": "example"
},
"expires_at": "example",
"public_url": "example",
"qr_url": "example",
"qr_expires_at": "example",
"metrics": {
"total": 1,
"passed": 1,
"failed": 1,
"skipped": 1
},
"created_at": "example",
"updated_at": "example"
}

Default Response

Media typeapplication/json
object
error
required
object
code
required
string
title
required
string
detail
required
string
docs
string
fields
object
key
additional properties
requestId
required
string
timestamp
required
string
key
additional properties
any
key
additional properties
any
Examplegenerated
{
"error": {
"code": "example",
"title": "example",
"detail": "example",
"docs": "example",
"fields": {
"additionalProperty": "example"
},
"requestId": "example",
"timestamp": "example"
}
}

Default Response

Media typeapplication/json
object
error
required
object
code
required
string
title
required
string
detail
required
string
docs
string
fields
object
key
additional properties
requestId
required
string
timestamp
required
string
key
additional properties
any
key
additional properties
any
Examplegenerated
{
"error": {
"code": "example",
"title": "example",
"detail": "example",
"docs": "example",
"fields": {
"additionalProperty": "example"
},
"requestId": "example",
"timestamp": "example"
}
}

Default Response

Media typeapplication/json
object
error
required
object
code
required
string
title
required
string
detail
required
string
docs
string
fields
object
key
additional properties
requestId
required
string
timestamp
required
string
key
additional properties
any
key
additional properties
any
Examplegenerated
{
"error": {
"code": "example",
"title": "example",
"detail": "example",
"docs": "example",
"fields": {
"additionalProperty": "example"
},
"requestId": "example",
"timestamp": "example"
}
}

Default Response

Media typeapplication/json
object
error
required
object
code
required
string
title
required
string
detail
required
string
docs
string
fields
object
key
additional properties
requestId
required
string
timestamp
required
string
key
additional properties
any
key
additional properties
any
Examplegenerated
{
"error": {
"code": "example",
"title": "example",
"detail": "example",
"docs": "example",
"fields": {
"additionalProperty": "example"
},
"requestId": "example",
"timestamp": "example"
}
}

Default Response

Media typeapplication/json
object
error
required
object
code
required
string
title
required
string
detail
required
string
docs
string
fields
object
key
additional properties
requestId
required
string
timestamp
required
string
key
additional properties
any
key
additional properties
any
Examplegenerated
{
"error": {
"code": "example",
"title": "example",
"detail": "example",
"docs": "example",
"fields": {
"additionalProperty": "example"
},
"requestId": "example",
"timestamp": "example"
}
}