Download OpenAPI specification:Download
The Farmer registry interoperability APIs describes different APIs some of them are usecase specific and other are generalized APIs to perform interoperable operations between Farmer registry and SP system. You can now help us improve the API whether it's by making changes to the definition itself or to the code. That way, with time, we can improve the API in general, and expose some of the new features in upcoming version.
Gitbook reference link:
Code directory links:
Data Objects:
Each request is build up of three parts
Search person(s) in registry using identifier or custom attributes
signature | string (MsgSignature) Signature of {header}+{message} body verified using sender's signing public key |
required | object Message header |
required | SearchRequest (object) or EncryptedMessage (object) The search data using which registry search to be performed |
{- "signature": "Signature: namespace=\"spdci\", kidId=\"{sender_id}|{unique_key_id}|{algorithm}\", algorithm=\"ed25519\", created=\"1606970629\", expires=\"1607030629\", headers=\"(created) (expires) digest\", signature=\"Base64(signing content)",
- "header": {
- "version": "1.0.0",
- "message_id": "123",
- "message_ts": "",
- "action": "search",
- "sender_id": "spmis.example.org",
- "receiver_id": "farmer.example.org",
- "total_count": 21800,
- "is_msg_encrypted": false,
- "meta": { }
}, - "message": {
- "transaction_id": 123456789,
- "search_request": [
- {
- "reference_id": "12345678901234567890",
- "timestamp": "",
- "search_criteria": {
- "version": "1.0.0",
- "reg_type": "ns:org:RegistryType:FR",
- "reg_event_type": "spdci-common:RegistryEventType:FRPerson",
- "query_type": "expression",
- "query": {
- "type": "ns:org:QueryType:expression",
- "value": {
- "expression": {
- "query": {
- "$and": [
- {
- "farm_info.location.geo.latitude": {
- "$eq": 9.56
}
}, - {
- "farm_info.location.geo.longitude": {
- "$eq": 100.0245
}
}
]
}
}
}
}, - "sort": [
- {
- "attribute_name": "poverty_score",
- "sort_order": "asc"
}
], - "pagination": {
- "page_size": 2000,
- "page_number": 5
}, - "consent": {
- "@type": "Consent",
- "ts": {
- "$ref": "#/components/schemas/SubscriptionInfo/properties/timestamp"
}, - "purpose": {
- "text": {
- "type": "string"
}, - "code": {
- "type": "string",
- "description": "From a fixed set, documented at refUri"
}, - "ref_uri": {
- "type": "string",
- "format": "uri",
- "description": "Uri to provide more info on consent codes"
}
}
}, - "authorize": {
- "@type": "Authorize",
- "ts": {
- "$ref": "#/components/schemas/SubscriptionInfo/properties/timestamp"
}, - "purpose": {
- "text": {
- "type": "string"
}, - "code": {
- "type": "string",
- "description": "From a fixed set, documented at refUri"
}, - "ref_uri": {
- "type": "string",
- "format": "uri",
- "description": "Uri to provide more info on authorize codes"
}
}
}
}, - "locale": "en"
}
]
}
}
{- "errors": [
- {
- "code": "string",
- "message": "string"
}
]
}
Search results through callback
signature | string (MsgSignature) Signature of {header}+{message} body verified using sender's signing public key |
required | object Message header |
SearchResponse (object) or EncryptedMessage (object) |
{- "signature": "Signature: namespace=\"spdci\", kidId=\"{sender_id}|{unique_key_id}|{algorithm}\", algorithm=\"ed25519\", created=\"1606970629\", expires=\"1607030629\", headers=\"(created) (expires) digest\", signature=\"Base64(signing content)",
- "header": {
- "version": "1.0.0",
- "message_id": "789",
- "message_ts": "",
- "action": "on-search",
- "status": "rcvd",
- "status_reason_code": "rjct.version.invalid",
- "status_reason_message": "string",
- "total_count": 21800,
- "completed_count": 50,
- "sender_id": "fr.example.org",
- "receiver_id": "spmis.example.org",
- "is_msg_encrypted": false,
- "meta": { }
}, - "message": {
- "transaction_id": 123456789,
- "correlation_id": "9876543210",
- "search_response": [
- {
- "reference_id": "12345678901234567890",
- "timestamp": "",
- "status": "rcvd",
- "status_reason_code": "rjct.reference_id.invalid",
- "status_reason_message": "string",
- "data": {
- "version": "1.0.0",
- "reg_type": "ns:org:RegistryType:FR",
- "reg_event_type": "spdci-common:RegistryEventType:FRPerson",
- "reg_record_type": "spdci-extensions-dci:FRPerson",
- "reg_records": {
- "type": "object",
- "description": "1. Attributes of a person to create fetch records, create verifiable credentials or use in search criteria.\n\n\n@context: https://schema.spdci.org/extensions/gr/v1/FRPerspn.jsonld <br>\n@type: \"@context\" <br>\n",
- "example": {
- "famer_personal_details": {
- "member_identifier": {
- "identifier_type": "NationalID",
- "identifier_value": "M123456"
}, - "demographic_info": {
- "identifier": {
- "identifier_type": "NationalID",
- "identifier_value": "M123456"
}, - "name": {
- "first_name": "John",
- "last_name": "Doe"
}, - "date_of_birth": "1990-05-15T00:00:00Z",
- "gender": "Male"
}
}, - "family_details": {
- "group_identifier": [
- {
- "identifier_type": "NationalID",
- "identifier_value": "G9876543210"
}
], - "group_type": "family",
- "poverty_score": 45.2,
- "poverty_score_type": "income-based",
- "group_head_info": {
- "member_identifier": [
- {
- "identifier_type": "NationalID",
- "identifier_value": "M123456"
}
], - "demographic_info": {
- "identifier": {
- "identifier_type": "NationalID",
- "identifier_value": "M123456"
}, - "name": {
- "first_name": "John",
- "last_name": "Doe"
}, - "date_of_birth": "1990-05-15T00:00:00Z",
- "gender": "Male"
}, - "is_disabled": false,
- "marital_status": "married",
- "registration_date": "1990-06-10T08:00:00Z"
}, - "group_size": 2,
- "member_list": [
- {
- "member_identifier": [
- {
- "@type": "Identifier",
- "identifier_type": "NationalID",
- "identifier_value": "M9876543210"
}
], - "demographic_info": {
- "spdci:identifier": [
- {
- "@type": "Identifier",
- "identifier_type": "NationalID",
- "identifier_value": "1234567890"
}
], - "name": {
- "@type": "Name",
- "surname": "Doe",
- "given_name": "Jane",
- "prefix": "Mr.",
- "suffix": ""
}, - "sex": "female",
- "birth_date": "1982-03-15T00:00:00Z",
- "registration_date": "2022-01-10T08:00:00Z"
}, - "is_disabled": false,
- "marital_status": "married",
- "registration_date": "2022-01-10T08:00:00Z"
}
], - "registration_date": "2022-01-10T08:00:00Z",
- "last_updated": "2023-06-15T10:00:00Z"
}, - "farm_details": [
- {
- "place": {
- "name": "Koh Samui",
- "geo": {
- "@type": "spdci:GeoLocation",
- "latitude": 9.5604,
- "longitude": 100.0245
}
}, - "farm_type": "Small subsistence-oriented farms",
- "farming_activities": [
- {
- "crop_production": [
- {
- "activity_group": "perennial crops",
- "crop_type": "Fruit and nuts",
- "variety": "local",
- "season": "winter",
- "end_use": [
- "Food for human consumption"
], - "irrigation": true,
- "irrigation_water": [
- "Mixed surface water and groundwater"
], - "fertilizer_type": [
- "Organic fertilizers"
], - "registration_date": "2023-01-10T00:00:00Z",
- "last_updated": "2023-09-20T00:00:00Z"
}
], - "animal_production": [
- {
- "type": "Sheep and goats",
- "count": 10,
- "livestock_system": "Mixed system",
- "registration_date": "2023-01-10T00:00:00Z",
- "last_updated": "2023-09-20T00:00:00Z"
}
], - "mixed_farming": true,
- "agri_support_activities": [
- "Support activities for crop production"
], - "aqua_support_activities": "Support activities for fishing and aquaculture",
- "aqua_culture": [
- "Marine aquafarming"
], - "registration_date": "2023-01-10T00:00:00Z",
- "last_updated": "2023-09-20T00:00:00Z"
}
]
}
], - "machineries_details": [
- {
- "type": "Machine powered equipment",
- "count": 2,
- "equipement_source": "Provided by a cooperative",
- "registration_date": "2022-01-10T08:00:00Z",
- "last_updated": "2023-06-15T10:00:00Z"
}
], - "registration_date": "2023-01-10T00:00:00Z",
- "last_updated": "2023-09-20T00:00:00Z"
}
}
}, - "pagination": {
- "page_size": 2000,
- "page_number": 5,
- "total_count": 24250
}, - "locale": "en"
}
]
}
}
{- "errors": [
- {
- "code": "string",
- "message": "string"
}
]
}
Subscribe to a life event with registry
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 |
{- "signature": "Signature: namespace=\"spdci\", kidId=\"{sender_id}|{unique_key_id}|{algorithm}\", algorithm=\"ed25519\", created=\"1606970629\", expires=\"1607030629\", headers=\"(created) (expires) digest\", signature=\"Base64(signing content)",
- "header": {
- "version": "1.0.0",
- "message_id": "123",
- "message_ts": "",
- "action": "subscribe",
- "sender_id": "spmis.example.org",
- "receiver_id": "farmer.example.org",
- "total_count": 21800,
- "is_msg_encrypted": false,
- "meta": { }
}, - "message": {
- "transaction_id": 123456789,
- "subscribe_request": [
- {
- "reference_id": "12345678901234567890",
- "timestamp": "",
- "subscribe_criteria": {
- "version": "1.0.0",
- "reg_type": "ns:org:RegistryType:Civil",
- "reg_event_type": "spdci-common:RegistryEventType:LiveBirth",
- "frequency": {
- "start_time": "",
- "end_time": "",
- "frequency": "string"
}, - "filter_type": "expression",
- "filter": {
- "type": "ns:org:QueryType:graphql",
- "value": {
- "expression": " query GeBirthRecordById: { person: (UIN: \"1\") { BRN, name, gender, birthDate, birthPlace, parents } } "
}
}, - "notify_record_type": "spdci-extensions-dci:Person",
- "authorize": {
- "@type": "Authorize",
- "ts": {
- "$ref": "#/components/schemas/SubscriptionInfo/properties/timestamp"
}, - "purpose": {
- "text": {
- "type": "string"
}, - "code": {
- "type": "string",
- "description": "From a fixed set, documented at refUri"
}, - "ref_uri": {
- "type": "string",
- "format": "uri",
- "description": "Uri to provide more info on authorize codes"
}
}
}
}, - "locale": "en"
}
]
}
}
{- "errors": [
- {
- "code": "string",
- "message": "string"
}
]
}
Unsubscribe existing subscription(s) by subscription_code
signature | string (MsgSignature) Signature of {header}+{message} body verified using sender's signing public key |
required | object Message header |
required | UnSubscribeRequest (object) or EncryptedMessage (object) The unsubscribe request that contain subscription ids which to be removed from subscription list |
{- "signature": "Signature: namespace=\"spdci\", kidId=\"{sender_id}|{unique_key_id}|{algorithm}\", algorithm=\"ed25519\", created=\"1606970629\", expires=\"1607030629\", headers=\"(created) (expires) digest\", signature=\"Base64(signing content)",
- "header": {
- "version": "1.0.0",
- "message_id": "123",
- "message_ts": "",
- "action": "unsubscribe",
- "sender_id": "spmis.example.org",
- "receiver_id": "farmer.example.org",
- "total_count": 21800,
- "is_msg_encrypted": false,
- "meta": { }
}, - "message": {
- "transaction_id": 123456789,
- "timesstamp": "",
- "subscription_codes": [
- "string"
]
}
}
{- "errors": [
- {
- "code": "string",
- "message": "string"
}
]
}
Unsubscribe response as a callback
signature | string (MsgSignature) Signature of {header}+{message} body verified using sender's signing public key |
required | object Message header |
required | UnSubscribeResponse (object) or EncryptedMessage (object) |
{- "signature": "Signature: namespace=\"spdci\", kidId=\"{sender_id}|{unique_key_id}|{algorithm}\", algorithm=\"ed25519\", created=\"1606970629\", expires=\"1607030629\", headers=\"(created) (expires) digest\", signature=\"Base64(signing content)",
- "header": {
- "version": "1.0.0",
- "message_id": "123",
- "message_ts": "",
- "action": "on-unsubscribe",
- "sender_id": "spmis.example.org",
- "receiver_id": "farmer.example.org",
- "total_count": 21800,
- "is_msg_encrypted": false,
- "meta": { }
}, - "message": {
- "transaction_id": 123456789,
- "correlation_id": "9876543210",
- "timesatmp": "",
- "status": "rcvd",
- "status_reason_code": "rjct.reference_id.invalid",
- "status_reason_message": "string",
- "subscription_status": [
- {
- "code": "string",
- "status": "subscribe"
}
]
}
}
{- "errors": [
- {
- "code": "string",
- "message": "string"
}
]
}
The /registry/txn/status will be implemented by FR. This will check status of reach request using transaction_id and/or reference_id(s).
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) |
{- "signature": "Signature: namespace=\"spdci\", kidId=\"{sender_id}|{unique_key_id}|{algorithm}\", algorithm=\"ed25519\", created=\"1606970629\", expires=\"1607030629\", headers=\"(created) (expires) digest\", signature=\"Base64(signing content)",
- "header": {
- "version": "1.0.0",
- "message_id": "123",
- "message_ts": "",
- "action": "txn-status",
- "sender_id": "spmis.example.org",
- "receiver_id": "farmer.example.org",
- "total_count": 21800,
- "is_msg_encrypted": false,
- "meta": { }
}, - "message": {
- "transaction_id": 123456789,
- "txnstatus_request": {
- "reference_id": "12345678901234567890",
- "txn_type": "search",
- "attribute_type": "transaction_id",
- "attribute_value": 123456789,
- "locale": "en"
}
}
}
{- "errors": [
- {
- "code": "string",
- "message": "string"
}
]
}
The /registry/txn/on-status will be implemented by SP-System. The response with information about request and in some case it may contain data as well.
signature | string (MsgSignature) Signature of {header}+{message} body verified using sender's signing public key |
required | object Message header |
TxnStatusResponse (object) or EncryptedMessage (object) |
{- "signature": "Signature: namespace=\"spdci\", kidId=\"{sender_id}|{unique_key_id}|{algorithm}\", algorithm=\"ed25519\", created=\"1606970629\", expires=\"1607030629\", headers=\"(created) (expires) digest\", signature=\"Base64(signing content)",
- "header": {
- "version": "1.0.0",
- "message_id": "789",
- "message_ts": "",
- "action": "txn-on-status",
- "status": "rcvd",
- "status_reason_code": "rjct.version.invalid",
- "status_reason_message": "string",
- "total_count": 21800,
- "completed_count": 50,
- "sender_id": "fr.example.org",
- "receiver_id": "spmis.example.org",
- "is_msg_encrypted": false,
- "meta": { }
}, - "message": {
- "transaction_id": 123456789,
- "correlation_id": "9876543210",
- "txnstatus_response": {
- "type": "object",
- "description": "Response to search request. Multiple repsonses for each page can be pushed to the caller as an implementation!",
- "properties": {
- "transaction_id": {
- "$ref": "#/components/schemas/SearchRequest/properties/transaction_id"
}, - "correlation_id": {
- "$ref": "#/components/schemas/SearchResponse/properties/correlation_id"
}, - "search_response": {
- "type": "array",
- "items": {
- "type": "object",
- "properties": {
- "reference_id": {
- "$ref": "#/components/schemas/TxnStatusRequest/properties/txnstatus_request/properties/reference_id"
}, - "timestamp": {
- "$ref": "#/components/schemas/SubscriptionInfo/properties/timestamp"
}, - "status": {
- "$ref": "#/components/schemas/UnSubscribeResponse/properties/status"
}, - "status_reason_code": {
- "$ref": "#/components/schemas/SearchStatusReasonCode"
}, - "status_reason_message": {
- "description": "Status reason code message. Helps actionanble messaging for systems/end users",
- "type": "string",
- "maxLength": 999
}, - "data": {
- "type": "object",
- "description": "Search result record as an outcome of search/subscribe action\n",
- "properties": {
- "version": {
- "type": "string",
- "default": "1.0.0"
}, - "reg_type": {
- "$ref": "#/components/schemas/SubscriptionInfo/properties/reg_type"
}, - "reg_event_type": {
- "$ref": "#/components/schemas/SubscriptionInfo/properties/reg_event_type"
}, - "reg_record_type": {
- "$ref": "#/components/schemas/NotifyEventRequest/properties/notify_event/items/properties/data/properties/reg_record_type"
}, - "reg_records": {
- "$ref": "#/components/schemas/NotifyEventRequest/properties/notify_event/items/properties/data/properties/reg_records"
}
}, - "required": [
- "reg_record_type",
- "reg_records"
]
}, - "pagination": {
- "$ref": "#/components/schemas/SearchResponse/properties/search_response/items/properties/pagination"
}, - "locale": {
- "$ref": "#/components/schemas/SubscriptionInfo/properties/locale"
}
}, - "required": [
- "reference_id",
- "timestamp",
- "status"
]
}
}
}, - "required": [
- "transaction_id",
- "correlation_id",
- "search_response"
]
}
}
}
{- "errors": [
- {
- "code": "string",
- "message": "string"
}
]
}
The sync search api will accept request and will send response immediately The search request message consist of reg_event_type, query_type, query, sort, pagination, consent, authorize, locale. The IBR will validate the request and will send response to on-search endpoint. Information for each field is given below.
signature | string (MsgSignature) Signature of {header}+{message} body verified using sender's signing public key |
required | object Message header |
required | SearchRequest (object) or EncryptedMessage (object) The search data using which registry search to be performed |
{- "signature": "Signature: namespace=\"spdci\", kidId=\"{sender_id}|{unique_key_id}|{algorithm}\", algorithm=\"ed25519\", created=\"1606970629\", expires=\"1607030629\", headers=\"(created) (expires) digest\", signature=\"Base64(signing content)",
- "header": {
- "version": "1.0.0",
- "message_id": "123",
- "message_ts": "",
- "action": "search",
- "sender_id": "spmis.example.org",
- "receiver_id": "farmer.example.org",
- "total_count": 21800,
- "is_msg_encrypted": false,
- "meta": { }
}, - "message": {
- "transaction_id": 123456789,
- "search_request": [
- {
- "reference_id": "12345678901234567890",
- "timestamp": "",
- "search_criteria": {
- "version": "1.0.0",
- "reg_type": "ns:org:RegistryType:FR",
- "reg_event_type": "spdci-common:RegistryEventType:FRPerson",
- "query_type": "expression",
- "query": {
- "type": "ns:org:QueryType:expression",
- "value": {
- "expression": {
- "query": {
- "$and": [
- {
- "farm_info.location.geo.latitude": {
- "$eq": 9.56
}
}, - {
- "farm_info.location.geo.longitude": {
- "$eq": 100.0245
}
}
]
}
}
}
}, - "sort": [
- {
- "attribute_name": "poverty_score",
- "sort_order": "asc"
}
], - "pagination": {
- "page_size": 2000,
- "page_number": 5
}, - "consent": {
- "@type": "Consent",
- "ts": {
- "$ref": "#/components/schemas/SubscriptionInfo/properties/timestamp"
}, - "purpose": {
- "text": {
- "type": "string"
}, - "code": {
- "type": "string",
- "description": "From a fixed set, documented at refUri"
}, - "ref_uri": {
- "type": "string",
- "format": "uri",
- "description": "Uri to provide more info on consent codes"
}
}
}, - "authorize": {
- "@type": "Authorize",
- "ts": {
- "$ref": "#/components/schemas/SubscriptionInfo/properties/timestamp"
}, - "purpose": {
- "text": {
- "type": "string"
}, - "code": {
- "type": "string",
- "description": "From a fixed set, documented at refUri"
}, - "ref_uri": {
- "type": "string",
- "format": "uri",
- "description": "Uri to provide more info on authorize codes"
}
}
}
}, - "locale": "en"
}
]
}
}
{- "errors": [
- {
- "code": "string",
- "message": "string"
}
]
}
The /registry/sync/txn/status will be implemented by IBR. This will check status of reach request using transaction_id and/or reference_id(s).
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) |
{- "signature": "Signature: namespace=\"spdci\", kidId=\"{sender_id}|{unique_key_id}|{algorithm}\", algorithm=\"ed25519\", created=\"1606970629\", expires=\"1607030629\", headers=\"(created) (expires) digest\", signature=\"Base64(signing content)",
- "header": {
- "version": "1.0.0",
- "message_id": "123",
- "message_ts": "",
- "action": "txn-status",
- "sender_id": "spmis.example.org",
- "receiver_id": "farmer.example.org",
- "total_count": 21800,
- "is_msg_encrypted": false,
- "meta": { }
}, - "message": {
- "transaction_id": 123456789,
- "txnstatus_request": {
- "reference_id": "12345678901234567890",
- "txn_type": "search",
- "attribute_type": "transaction_id",
- "attribute_value": 123456789,
- "locale": "en"
}
}
}
{- "errors": [
- {
- "code": "string",
- "message": "string"
}
]
}
transaction_id required | string <= 99 characters
|
required | Array of objects
|
{- "transaction_id": 123456789,
- "search_request": [
- {
- "reference_id": "12345678901234567890",
- "timestamp": "",
- "search_criteria": {
- "version": "1.0.0",
- "reg_type": "ns:org:RegistryType:FR",
- "reg_event_type": "spdci-common:RegistryEventType:FRPerson",
- "query_type": "expression",
- "query": {
- "type": "ns:org:QueryType:expression",
- "value": {
- "expression": {
- "query": {
- "$and": [
- {
- "farm_info.location.geo.latitude": {
- "$eq": 9.56
}
}, - {
- "farm_info.location.geo.longitude": {
- "$eq": 100.0245
}
}
]
}
}
}
}, - "sort": [
- {
- "attribute_name": "poverty_score",
- "sort_order": "asc"
}
], - "pagination": {
- "page_size": 2000,
- "page_number": 5
}, - "consent": {
- "@type": "Consent",
- "ts": {
- "$ref": "#/components/schemas/SubscriptionInfo/properties/timestamp"
}, - "purpose": {
- "text": {
- "type": "string"
}, - "code": {
- "type": "string",
- "description": "From a fixed set, documented at refUri"
}, - "ref_uri": {
- "type": "string",
- "format": "uri",
- "description": "Uri to provide more info on consent codes"
}
}
}, - "authorize": {
- "@type": "Authorize",
- "ts": {
- "$ref": "#/components/schemas/SubscriptionInfo/properties/timestamp"
}, - "purpose": {
- "text": {
- "type": "string"
}, - "code": {
- "type": "string",
- "description": "From a fixed set, documented at refUri"
}, - "ref_uri": {
- "type": "string",
- "format": "uri",
- "description": "Uri to provide more info on authorize codes"
}
}
}
}, - "locale": "en"
}
]
}
transaction_id required | string <= 99 characters
|
correlation_id required | string <= 99 characters
|
required | Array of objects |
{- "transaction_id": 123456789,
- "correlation_id": "9876543210",
- "search_response": [
- {
- "reference_id": "12345678901234567890",
- "timestamp": "",
- "status": "rcvd",
- "status_reason_code": "rjct.reference_id.invalid",
- "status_reason_message": "string",
- "data": {
- "version": "1.0.0",
- "reg_type": "ns:org:RegistryType:FR",
- "reg_event_type": "spdci-common:RegistryEventType:FRPerson",
- "reg_record_type": "spdci-extensions-dci:FRPerson",
- "reg_records": {
- "type": "object",
- "description": "1. Attributes of a person to create fetch records, create verifiable credentials or use in search criteria.\n\n\n@context: https://schema.spdci.org/extensions/gr/v1/FRPerspn.jsonld <br>\n@type: \"@context\" <br>\n",
- "example": {
- "famer_personal_details": {
- "member_identifier": {
- "identifier_type": "NationalID",
- "identifier_value": "M123456"
}, - "demographic_info": {
- "identifier": {
- "identifier_type": "NationalID",
- "identifier_value": "M123456"
}, - "name": {
- "first_name": "John",
- "last_name": "Doe"
}, - "date_of_birth": "1990-05-15T00:00:00Z",
- "gender": "Male"
}
}, - "family_details": {
- "group_identifier": [
- {
- "identifier_type": "NationalID",
- "identifier_value": "G9876543210"
}
], - "group_type": "family",
- "poverty_score": 45.2,
- "poverty_score_type": "income-based",
- "group_head_info": {
- "member_identifier": [
- {
- "identifier_type": "NationalID",
- "identifier_value": "M123456"
}
], - "demographic_info": {
- "identifier": {
- "identifier_type": "NationalID",
- "identifier_value": "M123456"
}, - "name": {
- "first_name": "John",
- "last_name": "Doe"
}, - "date_of_birth": "1990-05-15T00:00:00Z",
- "gender": "Male"
}, - "is_disabled": false,
- "marital_status": "married",
- "registration_date": "1990-06-10T08:00:00Z"
}, - "group_size": 2,
- "member_list": [
- {
- "member_identifier": [
- {
- "@type": "Identifier",
- "identifier_type": "NationalID",
- "identifier_value": "M9876543210"
}
], - "demographic_info": {
- "spdci:identifier": [
- {
- "@type": "Identifier",
- "identifier_type": "NationalID",
- "identifier_value": "1234567890"
}
], - "name": {
- "@type": "Name",
- "surname": "Doe",
- "given_name": "Jane",
- "prefix": "Mr.",
- "suffix": ""
}, - "sex": "female",
- "birth_date": "1982-03-15T00:00:00Z",
- "registration_date": "2022-01-10T08:00:00Z"
}, - "is_disabled": false,
- "marital_status": "married",
- "registration_date": "2022-01-10T08:00:00Z"
}
], - "registration_date": "2022-01-10T08:00:00Z",
- "last_updated": "2023-06-15T10:00:00Z"
}, - "farm_details": [
- {
- "place": {
- "name": "Koh Samui",
- "geo": {
- "@type": "spdci:GeoLocation",
- "latitude": 9.5604,
- "longitude": 100.0245
}
}, - "farm_type": "Small subsistence-oriented farms",
- "farming_activities": [
- {
- "crop_production": [
- {
- "activity_group": "perennial crops",
- "crop_type": "Fruit and nuts",
- "variety": "local",
- "season": "winter",
- "end_use": [
- "Food for human consumption"
], - "irrigation": true,
- "irrigation_water": [
- "Mixed surface water and groundwater"
], - "fertilizer_type": [
- "Organic fertilizers"
], - "registration_date": "2023-01-10T00:00:00Z",
- "last_updated": "2023-09-20T00:00:00Z"
}
], - "animal_production": [
- {
- "type": "Sheep and goats",
- "count": 10,
- "livestock_system": "Mixed system",
- "registration_date": "2023-01-10T00:00:00Z",
- "last_updated": "2023-09-20T00:00:00Z"
}
], - "mixed_farming": true,
- "agri_support_activities": [
- "Support activities for crop production"
], - "aqua_support_activities": "Support activities for fishing and aquaculture",
- "aqua_culture": [
- "Marine aquafarming"
], - "registration_date": "2023-01-10T00:00:00Z",
- "last_updated": "2023-09-20T00:00:00Z"
}
]
}
], - "machineries_details": [
- {
- "type": "Machine powered equipment",
- "count": 2,
- "equipement_source": "Provided by a cooperative",
- "registration_date": "2022-01-10T08:00:00Z",
- "last_updated": "2023-06-15T10:00:00Z"
}
], - "registration_date": "2023-01-10T00:00:00Z",
- "last_updated": "2023-09-20T00:00:00Z"
}
}
}, - "pagination": {
- "page_size": 2000,
- "page_number": 5,
- "total_count": 24250
}, - "locale": "en"
}
]
}
transaction_id required | string <= 99 characters
|
required | Array of objects |
{- "transaction_id": 123456789,
- "subscribe_request": [
- {
- "reference_id": "12345678901234567890",
- "timestamp": "",
- "subscribe_criteria": {
- "version": "1.0.0",
- "reg_type": "ns:org:RegistryType:Civil",
- "reg_event_type": "spdci-common:RegistryEventType:LiveBirth",
- "frequency": {
- "start_time": "",
- "end_time": "",
- "frequency": "string"
}, - "filter_type": "expression",
- "filter": {
- "type": "ns:org:QueryType:graphql",
- "value": {
- "expression": " query GeBirthRecordById: { person: (UIN: \"1\") { BRN, name, gender, birthDate, birthPlace, parents } } "
}
}, - "notify_record_type": "spdci-extensions-dci:Person",
- "authorize": {
- "@type": "Authorize",
- "ts": {
- "$ref": "#/components/schemas/SubscriptionInfo/properties/timestamp"
}, - "purpose": {
- "text": {
- "type": "string"
}, - "code": {
- "type": "string",
- "description": "From a fixed set, documented at refUri"
}, - "ref_uri": {
- "type": "string",
- "format": "uri",
- "description": "Uri to provide more info on authorize codes"
}
}
}
}, - "locale": "en"
}
]
}
transaction_id required | string <= 99 characters
|
correlation_id required | string <= 99 characters
|
required | Array of objects |
{- "transaction_id": 123456789,
- "correlation_id": "9876543210",
- "subscribe_response": [
- {
- "reference_id": "12345678901234567890",
- "timestamp": "",
- "status": "rcvd",
- "status_reason_code": "rjct.reference_id.invalid",
- "status_reason_message": "string",
- "subscriptions": [
- {
- "version": "1.0.0",
- "code": "string",
- "status": "subscribe",
- "timestamp": "",
- "reg_type": "ns:org:RegistryType:Civil",
- "reg_event_type": "spdci-common:RegistryEventType:LiveBirth",
- "frequency": {
- "start_time": "",
- "end_time": "",
- "frequency": "string"
}, - "filter_type": "expression",
- "filter": {
- "type": "ns:org:QueryType:graphql",
- "value": {
- "expression": " query GeBirthRecordById: { person: (UIN: \"1\") { BRN, name, gender, birthDate, birthPlace, parents } } "
}
}, - "notify_record_type": "spdci-extensions-dci:Person",
- "locale": "en"
}
], - "pagination": {
- "page_size": 2000,
- "page_number": 5,
- "total_count": 24250
}, - "locale": "en"
}
]
}
transaction_id required | string <= 99 characters
|
timesstamp | string <date-time>
|
subscription_codes | Array of strings (SubscriptionCode) [ items <= 99 characters ] |
{- "transaction_id": 123456789,
- "timesstamp": "",
- "subscription_codes": [
- "string"
]
}
transaction_id required | string <= 99 characters
|
correlation_id required | string <= 99 characters
|
timesatmp | string <date-time>
|
status required | string Enum: "rcvd" "pdng" "succ" "rjct" Request (e.g disburse, link, unlink, resolve, issue, search, verify, etc.,) status: |
status_reason_code | string (UnSubscribeStatusReasonCode) Enum: "rjct.reference_id.invalid" "rjct.reference_id.duplicate" "rjct.timestamp.invalid" "rjct.subscription_code.invalid" "rjct.requester.invalid" "rjct.event.already_unsubscribed" Identity verification request status reason codes |
status_reason_message | string <= 999 characters Status reason code message. Helps actionanble messaging for systems/end users |
Array of objects |
{- "transaction_id": 123456789,
- "correlation_id": "9876543210",
- "timesatmp": "",
- "status": "rcvd",
- "status_reason_code": "rjct.reference_id.invalid",
- "status_reason_message": "string",
- "subscription_status": [
- {
- "code": "string",
- "status": "subscribe"
}
]
}
transaction_id required | string <= 99 characters
|
required | object |
{- "transaction_id": 123456789,
- "txnstatus_request": {
- "reference_id": "12345678901234567890",
- "txn_type": "search",
- "attribute_type": "transaction_id",
- "attribute_value": 123456789,
- "locale": "en"
}
}
transaction_id required | string <= 99 characters
|
correlation_id required | string <= 99 characters
|
required | object |
{- "transaction_id": 123456789,
- "correlation_id": "9876543210",
- "txnstatus_response": {
- "type": "object",
- "description": "Response to search request. Multiple repsonses for each page can be pushed to the caller as an implementation!",
- "properties": {
- "transaction_id": {
- "$ref": "#/components/schemas/SearchRequest/properties/transaction_id"
}, - "correlation_id": {
- "$ref": "#/components/schemas/SearchResponse/properties/correlation_id"
}, - "search_response": {
- "type": "array",
- "items": {
- "type": "object",
- "properties": {
- "reference_id": {
- "$ref": "#/components/schemas/TxnStatusRequest/properties/txnstatus_request/properties/reference_id"
}, - "timestamp": {
- "$ref": "#/components/schemas/SubscriptionInfo/properties/timestamp"
}, - "status": {
- "$ref": "#/components/schemas/UnSubscribeResponse/properties/status"
}, - "status_reason_code": {
- "$ref": "#/components/schemas/SearchStatusReasonCode"
}, - "status_reason_message": {
- "description": "Status reason code message. Helps actionanble messaging for systems/end users",
- "type": "string",
- "maxLength": 999
}, - "data": {
- "type": "object",
- "description": "Search result record as an outcome of search/subscribe action\n",
- "properties": {
- "version": {
- "type": "string",
- "default": "1.0.0"
}, - "reg_type": {
- "$ref": "#/components/schemas/SubscriptionInfo/properties/reg_type"
}, - "reg_event_type": {
- "$ref": "#/components/schemas/SubscriptionInfo/properties/reg_event_type"
}, - "reg_record_type": {
- "$ref": "#/components/schemas/NotifyEventRequest/properties/notify_event/items/properties/data/properties/reg_record_type"
}, - "reg_records": {
- "$ref": "#/components/schemas/NotifyEventRequest/properties/notify_event/items/properties/data/properties/reg_records"
}
}, - "required": [
- "reg_record_type",
- "reg_records"
]
}, - "pagination": {
- "$ref": "#/components/schemas/SearchResponse/properties/search_response/items/properties/pagination"
}, - "locale": {
- "$ref": "#/components/schemas/SubscriptionInfo/properties/locale"
}
}, - "required": [
- "reference_id",
- "timestamp",
- "status"
]
}
}
}, - "required": [
- "transaction_id",
- "correlation_id",
- "search_response"
]
}
}
required | object |
ciphertext required | string This is the result of encrypting the plaintext using the CEK and the IV. It's Base64Url-encoded. |
encrypted_key required | string The base64-url encoded encrypted key |
tag required | string This is a Base64Url-encoded value that provides evidence of the integrity and authenticity of the ciphertext, Initialization Vector, and Additional Authenticated Data |
iv required | string This is a Base64Url-encoded random bit string to be used as the Initialization Vector (IV) when encrypting the plaintext to produce the ciphertext. The size of the IV depends on the encryption algorithm used. |
{- "header": {
- "alg": "string",
- "enc": "string",
- "kid": "string"
}, - "ciphertext": "string",
- "encrypted_key": "string",
- "tag": "string",
- "iv": "string"
}
Identity verification request status reason codes
"rjct.reference_id.invalid"
Identity verification request status reason codes
"rjct.reference_id.invalid"
Identity verification request status reason codes
"rjct.reference_id.invalid"