Sign a document
curl --request POST \
--url https://sandbox.api.nkama.ga/api/v1/documents/{id}/sign \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"challengeId": "<string>",
"code": "<string>"
}
'import requests
url = "https://sandbox.api.nkama.ga/api/v1/documents/{id}/sign"
payload = {
"challengeId": "<string>",
"code": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({challengeId: '<string>', code: '<string>'})
};
fetch('https://sandbox.api.nkama.ga/api/v1/documents/{id}/sign', 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://sandbox.api.nkama.ga/api/v1/documents/{id}/sign",
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([
'challengeId' => '<string>',
'code' => '<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://sandbox.api.nkama.ga/api/v1/documents/{id}/sign"
payload := strings.NewReader("{\n \"challengeId\": \"<string>\",\n \"code\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", 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.post("https://sandbox.api.nkama.ga/api/v1/documents/{id}/sign")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"challengeId\": \"<string>\",\n \"code\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox.api.nkama.ga/api/v1/documents/{id}/sign")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"challengeId\": \"<string>\",\n \"code\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"certificateRef": "<string>",
"certifiedOn": "2023-12-25",
"certifyingAuthority": "POLICE",
"documentType": "NATIONAL_ID",
"expiresOn": "2023-12-25",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"mediaObjectId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"role": "SELF_ID"
}{
"detail": "<string>",
"instance": "<string>",
"properties": {},
"status": 123,
"title": "<string>",
"type": "<string>"
}{
"detail": "<string>",
"instance": "<string>",
"properties": {},
"status": 123,
"title": "<string>",
"type": "<string>"
}{
"detail": "<string>",
"instance": "<string>",
"properties": {},
"status": 123,
"title": "<string>",
"type": "<string>"
}{
"detail": "<string>",
"instance": "<string>",
"properties": {},
"status": 123,
"title": "<string>",
"type": "<string>"
}{
"detail": "<string>",
"instance": "<string>",
"properties": {},
"status": 123,
"title": "<string>",
"type": "<string>"
}{
"detail": "<string>",
"instance": "<string>",
"properties": {},
"status": 123,
"title": "<string>",
"type": "<string>"
}Documents
Sign a document
Records a signature in the given capacity once the one-time code from the sign/otp step verifies. Signing an already-signed document is idempotent; voided documents cannot be signed.
POST
/
api
/
v1
/
documents
/
{id}
/
sign
Sign a document
curl --request POST \
--url https://sandbox.api.nkama.ga/api/v1/documents/{id}/sign \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"challengeId": "<string>",
"code": "<string>"
}
'import requests
url = "https://sandbox.api.nkama.ga/api/v1/documents/{id}/sign"
payload = {
"challengeId": "<string>",
"code": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({challengeId: '<string>', code: '<string>'})
};
fetch('https://sandbox.api.nkama.ga/api/v1/documents/{id}/sign', 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://sandbox.api.nkama.ga/api/v1/documents/{id}/sign",
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([
'challengeId' => '<string>',
'code' => '<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://sandbox.api.nkama.ga/api/v1/documents/{id}/sign"
payload := strings.NewReader("{\n \"challengeId\": \"<string>\",\n \"code\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", 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.post("https://sandbox.api.nkama.ga/api/v1/documents/{id}/sign")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"challengeId\": \"<string>\",\n \"code\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox.api.nkama.ga/api/v1/documents/{id}/sign")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"challengeId\": \"<string>\",\n \"code\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"certificateRef": "<string>",
"certifiedOn": "2023-12-25",
"certifyingAuthority": "POLICE",
"documentType": "NATIONAL_ID",
"expiresOn": "2023-12-25",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"mediaObjectId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"role": "SELF_ID"
}{
"detail": "<string>",
"instance": "<string>",
"properties": {},
"status": 123,
"title": "<string>",
"type": "<string>"
}{
"detail": "<string>",
"instance": "<string>",
"properties": {},
"status": 123,
"title": "<string>",
"type": "<string>"
}{
"detail": "<string>",
"instance": "<string>",
"properties": {},
"status": 123,
"title": "<string>",
"type": "<string>"
}{
"detail": "<string>",
"instance": "<string>",
"properties": {},
"status": 123,
"title": "<string>",
"type": "<string>"
}{
"detail": "<string>",
"instance": "<string>",
"properties": {},
"status": 123,
"title": "<string>",
"type": "<string>"
}{
"detail": "<string>",
"instance": "<string>",
"properties": {},
"status": 123,
"title": "<string>",
"type": "<string>"
}Authorizations
Bearer access token (JWT) issued by Keycloak or the sandbox token endpoint.
Path Parameters
Document id
Body
application/json
Request to record a signature on a document, gated by a one-time code.
Response
The document, now signed
Available options:
POLICE, MAIRIE, NOTARY, NONE Available options:
NATIONAL_ID, PASSPORT, RESIDENCE_PERMIT, DRIVER_LICENSE Available options:
SELF_ID, PROOF_OF_OWNERSHIP, ATTESTATION, OWNER_MANDATE, OWNER_ID, OTHER 
