Claim a pending credential under a fresh PID handle
curl --request POST \
--url https://api.pid.peridotvault.com/v1/auth/claim \
--header 'Content-Type: application/json' \
--data '
{
"handle": "ifal"
}
'const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({handle: 'ifal'})
};
fetch('https://api.pid.peridotvault.com/v1/auth/claim', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.pid.peridotvault.com/v1/auth/claim"
payload = { "handle": "ifal" }
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.pid.peridotvault.com/v1/auth/claim"
payload := strings.NewReader("{\n \"handle\": \"ifal\"\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))
}{
"ok": true,
"pid": "ifal@pid"
}{
"statusCode": 400,
"message": "No pending claim — sign in again to get a fresh one."
}{
"statusCode": 429,
"message": "ThrottlerException: Too Many Requests"
}auth
Claim a pending credential under a fresh PID handle
One transaction creates the identity (<handle>@pid, permanent) + profile
- credential and consumes the single-use claim ticket. Issues the session
cookies. When the claim came from a relying-party login, the response also
carries the SSO
pidCodeplus the validatedredirectTo— the hosted page navigates there itself. Expired tickets answer410— sign in again.
POST
/
auth
/
claim
Claim a pending credential under a fresh PID handle
curl --request POST \
--url https://api.pid.peridotvault.com/v1/auth/claim \
--header 'Content-Type: application/json' \
--data '
{
"handle": "ifal"
}
'const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({handle: 'ifal'})
};
fetch('https://api.pid.peridotvault.com/v1/auth/claim', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.pid.peridotvault.com/v1/auth/claim"
payload = { "handle": "ifal" }
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.pid.peridotvault.com/v1/auth/claim"
payload := strings.NewReader("{\n \"handle\": \"ifal\"\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))
}{
"ok": true,
"pid": "ifal@pid"
}{
"statusCode": 400,
"message": "No pending claim — sign in again to get a fresh one."
}{
"statusCode": 429,
"message": "ThrottlerException: Too Many Requests"
}Body
application/json
Permanent handle for <handle>@pid
Pattern:
^[a-z0-9_]{3,20}$Response
Claimed identity (+ SSO code and return target when applicable)