crew-certificates
Update Certificate
Partial update. If the certificate was verified and a reviewed field changed, its review state auto-reverts to pending (fingerprint mismatch).
PATCH
/
api
/
v1
/
crew
/
certificates
/
{certificate_id}
Update Certificate
curl --request PATCH \
--url https://api.example.com/api/v1/crew/certificates/{certificate_id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"certificateNumber": "<string>",
"issuingAuthority": "<string>",
"issueDate": "2023-12-25",
"expiryDate": "2023-12-25",
"uploadId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"notes": "<string>"
}
'import requests
url = "https://api.example.com/api/v1/crew/certificates/{certificate_id}"
payload = {
"certificateNumber": "<string>",
"issuingAuthority": "<string>",
"issueDate": "2023-12-25",
"expiryDate": "2023-12-25",
"uploadId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"notes": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
certificateNumber: '<string>',
issuingAuthority: '<string>',
issueDate: '2023-12-25',
expiryDate: '2023-12-25',
uploadId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
notes: '<string>'
})
};
fetch('https://api.example.com/api/v1/crew/certificates/{certificate_id}', 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/api/v1/crew/certificates/{certificate_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'certificateNumber' => '<string>',
'issuingAuthority' => '<string>',
'issueDate' => '2023-12-25',
'expiryDate' => '2023-12-25',
'uploadId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'notes' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"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/api/v1/crew/certificates/{certificate_id}"
payload := strings.NewReader("{\n \"certificateNumber\": \"<string>\",\n \"issuingAuthority\": \"<string>\",\n \"issueDate\": \"2023-12-25\",\n \"expiryDate\": \"2023-12-25\",\n \"uploadId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"notes\": \"<string>\"\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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.patch("https://api.example.com/api/v1/crew/certificates/{certificate_id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"certificateNumber\": \"<string>\",\n \"issuingAuthority\": \"<string>\",\n \"issueDate\": \"2023-12-25\",\n \"expiryDate\": \"2023-12-25\",\n \"uploadId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"notes\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/v1/crew/certificates/{certificate_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"certificateNumber\": \"<string>\",\n \"issuingAuthority\": \"<string>\",\n \"issueDate\": \"2023-12-25\",\n \"expiryDate\": \"2023-12-25\",\n \"uploadId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"notes\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"certificateType": "<string>",
"uploadedByUserId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"certificateNumber": "<string>",
"issuingAuthority": "<string>",
"issueDate": "2023-12-25",
"expiryDate": "2023-12-25",
"uploadId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"verification": {
"targetType": "<string>",
"targetId": "<string>",
"rejectionReason": "<string>",
"reviewedAt": "2023-11-07T05:31:56Z"
},
"notes": "<string>"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Body
application/json
Response
Successful Response
API response shape with computed status.
Computed at response time from expiry_date - today().
No unknown value — when there's no expiry_date we use VALID (the
document doesn't expire; treat as good).
Available options:
valid, expiring_soon, expired API response shape (camelCase). Used both as the per-item entry in a
profile summary and embedded as the verification field on a credential
response.
Show child attributes
Show child attributes
Was this page helpful?
⌘I
Update Certificate
curl --request PATCH \
--url https://api.example.com/api/v1/crew/certificates/{certificate_id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"certificateNumber": "<string>",
"issuingAuthority": "<string>",
"issueDate": "2023-12-25",
"expiryDate": "2023-12-25",
"uploadId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"notes": "<string>"
}
'import requests
url = "https://api.example.com/api/v1/crew/certificates/{certificate_id}"
payload = {
"certificateNumber": "<string>",
"issuingAuthority": "<string>",
"issueDate": "2023-12-25",
"expiryDate": "2023-12-25",
"uploadId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"notes": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
certificateNumber: '<string>',
issuingAuthority: '<string>',
issueDate: '2023-12-25',
expiryDate: '2023-12-25',
uploadId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
notes: '<string>'
})
};
fetch('https://api.example.com/api/v1/crew/certificates/{certificate_id}', 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/api/v1/crew/certificates/{certificate_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'certificateNumber' => '<string>',
'issuingAuthority' => '<string>',
'issueDate' => '2023-12-25',
'expiryDate' => '2023-12-25',
'uploadId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'notes' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"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/api/v1/crew/certificates/{certificate_id}"
payload := strings.NewReader("{\n \"certificateNumber\": \"<string>\",\n \"issuingAuthority\": \"<string>\",\n \"issueDate\": \"2023-12-25\",\n \"expiryDate\": \"2023-12-25\",\n \"uploadId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"notes\": \"<string>\"\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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.patch("https://api.example.com/api/v1/crew/certificates/{certificate_id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"certificateNumber\": \"<string>\",\n \"issuingAuthority\": \"<string>\",\n \"issueDate\": \"2023-12-25\",\n \"expiryDate\": \"2023-12-25\",\n \"uploadId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"notes\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/v1/crew/certificates/{certificate_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"certificateNumber\": \"<string>\",\n \"issuingAuthority\": \"<string>\",\n \"issueDate\": \"2023-12-25\",\n \"expiryDate\": \"2023-12-25\",\n \"uploadId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"notes\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"certificateType": "<string>",
"uploadedByUserId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"certificateNumber": "<string>",
"issuingAuthority": "<string>",
"issueDate": "2023-12-25",
"expiryDate": "2023-12-25",
"uploadId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"verification": {
"targetType": "<string>",
"targetId": "<string>",
"rejectionReason": "<string>",
"reviewedAt": "2023-11-07T05:31:56Z"
},
"notes": "<string>"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}