diff --git a/release/html/registry_core_api_v1_0.0.0.html b/release/html/registry_core_api_v1_0.0.0.html index c76dd1a..e25a081 100644 --- a/release/html/registry_core_api_v1_0.0.0.html +++ b/release/html/registry_core_api_v1_0.0.0.html @@ -265,6 +265,10 @@ data-styled.g63[id="sc-iHbSHJ"]{content:"jJvHFQ,"}/*!sc*/ .SbUMR{color:#d41f1c;font-size:0.9em;font-weight:normal;margin-left:20px;line-height:1;}/*!sc*/ data-styled.g64[id="sc-klVQfs"]{content:"SbUMR,"}/*!sc*/ +.dwcOCN{background:#11171a;}/*!sc*/ +.dwcOCN > div,.dwcOCN > pre{padding:20px;margin:0;}/*!sc*/ +.dwcOCN > div > pre{padding:0;}/*!sc*/ +data-styled.g78[id="sc-iMWBiJ"]{content:"dwcOCN,"}/*!sc*/ .erXvUb:after{content:' and ';font-weight:normal;}/*!sc*/ .erXvUb:last-child:after{content:none;}/*!sc*/ .erXvUb a{-webkit-text-decoration:auto;text-decoration:auto;color:#32329f;}/*!sc*/ @@ -322,8 +326,12 @@ .eXvsLO:first-child{padding-bottom:32px;}/*!sc*/ .sc-bpUBKd .sc-bpUBKd{font-size:0.929em;}/*!sc*/ data-styled.g102[id="sc-bpUBKd"]{content:"bpycMf,eXvsLO,"}/*!sc*/ +.gZRKBc{list-style:none inside none;overflow:hidden;text-overflow:ellipsis;padding:0;margin-top:15px;}/*!sc*/ .fbjDYy{list-style:none inside none;overflow:hidden;text-overflow:ellipsis;padding:0;}/*!sc*/ -data-styled.g103[id="sc-eyvILC"]{content:"fbjDYy,"}/*!sc*/ +data-styled.g103[id="sc-eyvILC"]{content:"gZRKBc,fbjDYy,"}/*!sc*/ +.dmFPjg{cursor:pointer;color:#333333;margin:0;padding:12.5px 20px;display:-webkit-box;display:-webkit-flex;display:-ms-flexbox;display:flex;-webkit-box-pack:justify;-webkit-justify-content:space-between;-ms-flex-pack:justify;justify-content:space-between;font-family:Montserrat,sans-serif;opacity:0.7;text-transform:uppercase;font-size:0.8em;padding-bottom:0;cursor:default;background-color:#fafafa;}/*!sc*/ +.dmFPjg .sc-cwHptR{height:1.5em;width:1.5em;}/*!sc*/ +.dmFPjg .sc-cwHptR polygon{fill:#333333;}/*!sc*/ .hlXHtc{cursor:pointer;color:#333333;margin:0;padding:12.5px 20px;display:-webkit-box;display:-webkit-flex;display:-ms-flexbox;display:flex;-webkit-box-pack:justify;-webkit-justify-content:space-between;-ms-flex-pack:justify;justify-content:space-between;font-family:Montserrat,sans-serif;font-size:0.929em;text-transform:none;background-color:#fafafa;}/*!sc*/ .hlXHtc:hover{color:#32329f;background-color:#e1e1e1;}/*!sc*/ .hlXHtc .sc-cwHptR{height:1.5em;width:1.5em;}/*!sc*/ @@ -332,7 +340,7 @@ .ioZqbe:hover{color:#32329f;background-color:#ededed;}/*!sc*/ .ioZqbe .sc-cwHptR{height:1.5em;width:1.5em;}/*!sc*/ .ioZqbe .sc-cwHptR polygon{fill:#333333;}/*!sc*/ -data-styled.g104[id="sc-gfoqjT"]{content:"hlXHtc,ioZqbe,"}/*!sc*/ +data-styled.g104[id="sc-gfoqjT"]{content:"dmFPjg,hlXHtc,ioZqbe,"}/*!sc*/ .jSTdPd{display:inline-block;vertical-align:middle;width:auto;overflow:hidden;text-overflow:ellipsis;}/*!sc*/ .dlJfXA{display:inline-block;vertical-align:middle;width:calc(100% - 38px);overflow:hidden;text-overflow:ellipsis;}/*!sc*/ data-styled.g105[id="sc-kbousE"]{content:"jSTdPd,dlJfXA,"}/*!sc*/ @@ -402,7 +410,7 @@ -
Digital Convergence Initiative
API docs by Redocly
Digital Convergence Initiative
API docs by Redocly
500

HTTP layer error details

Request samples

Content type
{
  • "signature": "Signature: namespace=\"g2p\", kidId=\"{sender_id}|{unique_key_id}|{algorithm}\", algorithm=\"ed25519\", created=\"1606970629\", expires=\"1607030629\", headers=\"(created) (expires) digest\", signature=\"Base64(signing content)",
  • "header": {
    },
  • "message": {
    }
}

Response samples

Content type
application/json
{
  • "error": {
    }
}

/registry/subscribe

Subscribe to a life event with registry

+
https://sandbox.spdci.org/namespace/v1.0.0/registry/on-search

Request samples

Content type
{
  • "signature": "Signature: namespace=\"g2p\", kidId=\"{sender_id}|{unique_key_id}|{algorithm}\", algorithm=\"ed25519\", created=\"1606970629\", expires=\"1607030629\", headers=\"(created) (expires) digest\", signature=\"Base64(signing content)",
  • "header": {
    },
  • "message": {
    }
}

Response samples

Content type
application/json
{
  • "error": {
    }
}

/registry/subscribe

Subscribe to a life event with registry

Authorizations:
x-access-token
Request Body schema:
signature
string (MsgSignature)

Signature of {header}+{message} body verified using sender's signing public key

required
object

Message header

required
SubscribeRequest (object) or EncryptedMessage (object)

Subscription request which contaion query with frequency and other info on which notification to be sent by registry to subscriber

@@ -472,7 +480,7 @@

Request samples

Content type
{
  • "signature": "Signature: namespace=\"g2p\", kidId=\"{sender_id}|{unique_key_id}|{algorithm}\", algorithm=\"ed25519\", created=\"1606970629\", expires=\"1607030629\", headers=\"(created) (expires) digest\", signature=\"Base64(signing content)",
  • "header": {
    },
  • "message": {
    }
}

Response samples

Content type
application/json
{
  • "error": {
    }
}

/registry/notify

Registry to notify a life event to subscrbiers

+
https://sandbox.spdci.org/namespace/v1.0.0/registry/subscribe

Request samples

Content type
{
  • "signature": "Signature: namespace=\"g2p\", kidId=\"{sender_id}|{unique_key_id}|{algorithm}\", algorithm=\"ed25519\", created=\"1606970629\", expires=\"1607030629\", headers=\"(created) (expires) digest\", signature=\"Base64(signing content)",
  • "header": {
    },
  • "message": {
    }
}

Response samples

Content type
application/json
{
  • "error": {
    }
}

/registry/notify

Registry to notify a life event to subscrbiers

Authorizations:
x-access-token
Request Body schema:
signature
string (MsgSignature)

Signature of {header}+{message} body verified using sender's signing public key

required
object

Message header

NotifyEventRequest (object) or EncryptedMessage (object)

Responses

Request samples

Content type
{
  • "signature": "Signature: namespace=\"g2p\", kidId=\"{sender_id}|{unique_key_id}|{algorithm}\", algorithm=\"ed25519\", created=\"1606970629\", expires=\"1607030629\", headers=\"(created) (expires) digest\", signature=\"Base64(signing content)",
  • "header": {
    },
  • "message": {
    }
}

Response samples

Content type
application/json
{
  • "error": {
    }
}

/registry/txn/status

Perform async status check of previous civil registry transanctions using transaction_id and/or reference_id(s)

+
https://sandbox.spdci.org/namespace/v1.0.0/registry/notify

Request samples

Content type
{
  • "signature": "Signature: namespace=\"g2p\", kidId=\"{sender_id}|{unique_key_id}|{algorithm}\", algorithm=\"ed25519\", created=\"1606970629\", expires=\"1607030629\", headers=\"(created) (expires) digest\", signature=\"Base64(signing content)",
  • "header": {
    },
  • "message": {
    }
}

Response samples

Content type
application/json
{
  • "error": {
    }
}

/registry/txn/status

Perform async status check of previous civil registry transanctions using transaction_id and/or reference_id(s)

Authorizations:
x-access-token
Request Body schema:
signature
string (MsgSignature)

Signature of {header}+{message} body verified using sender's signing public key

required
object

Message header

required
TxnStatusRequest (object) or EncryptedMessage (object)

Responses

Request samples

Content type
{
  • "signature": "Signature: namespace=\"g2p\", kidId=\"{sender_id}|{unique_key_id}|{algorithm}\", algorithm=\"ed25519\", created=\"1606970629\", expires=\"1607030629\", headers=\"(created) (expires) digest\", signature=\"Base64(signing content)",
  • "header": {
    },
  • "message": {
    }
}

Response samples

Content type
application/json
{
  • "error": {
    }
}

/registry/txn/on-status

Response to async status check of previous civil registrt transanctions using callback

+
https://sandbox.spdci.org/namespace/v1.0.0/registry/txn/status

Request samples

Content type
{
  • "signature": "Signature: namespace=\"g2p\", kidId=\"{sender_id}|{unique_key_id}|{algorithm}\", algorithm=\"ed25519\", created=\"1606970629\", expires=\"1607030629\", headers=\"(created) (expires) digest\", signature=\"Base64(signing content)",
  • "header": {
    },
  • "message": {
    }
}

Response samples

Content type
application/json
{
  • "error": {
    }
}

/registry/txn/on-status

Response to async status check of previous civil registrt transanctions using callback

Authorizations:
x-access-token
Request Body schema:
signature
string (MsgSignature)

Signature of {header}+{message} body verified using sender's signing public key

required
object

Message header

TxnStatusResponse (object) or EncryptedMessage (object)

Responses

Request samples

Content type
{
  • "signature": "Signature: namespace=\"g2p\", kidId=\"{sender_id}|{unique_key_id}|{algorithm}\", algorithm=\"ed25519\", created=\"1606970629\", expires=\"1607030629\", headers=\"(created) (expires) digest\", signature=\"Base64(signing content)",
  • "header": {
    },
  • "message": {
    }
}

Response samples

Content type
application/json
{
  • "error": {
    }
}

Sync

Sync endpoints

+
https://sandbox.spdci.org/namespace/v1.0.0/registry/txn/on-status

Request samples

Content type
{
  • "signature": "Signature: namespace=\"g2p\", kidId=\"{sender_id}|{unique_key_id}|{algorithm}\", algorithm=\"ed25519\", created=\"1606970629\", expires=\"1607030629\", headers=\"(created) (expires) digest\", signature=\"Base64(signing content)",
  • "header": {
    },
  • "message": {
    }
}

Response samples

Content type
application/json
{
  • "error": {
    }
}

Sync

Sync endpoints