Individual

Individual Registry

Maintain and manage individual registries.

Create/Add a new Individual

post

Create a new Individual

Query parameters

echoResourceanyoptional

Client can specify if the resource in request body needs to be sent back in the response. This is being used to limit amount of data that needs to flow back from the server to the client in low bandwidth scenarios. Server will always send the server generated id for validated requests.

Body

RequestInfoobjectrequired

RequestInfo should be used to carry meta information about the requests to the server as described in the fields below. All eGov APIs will use requestinfo as a part of the request body to carry this meta information. Some of this information will be returned back from the server as part of the ResponseInfo in the response body to ensure correlation.

Individualobjectrequired

A representation of an Individual.

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/individual/v1/_create' \
  --header 'Content-Type: application/json' \
  --data '{
    "RequestInfo": {
      "apiId": "text",
      "ver": "text",
      "ts": 1,
      "action": "text",
      "did": "text",
      "key": "text",
      "msgId": "text",
      "requesterId": "text",
      "authToken": "text"
    },
    "Individual": {
      "individualId": "text",
      "tenantId": "tenantA",
      "clientReferenceId": "text",
      "name": {
        "givenName": "text",
        "familyName": "text",
        "otherNames": "text"
      },
      "dateOfBirth": "14/10/2022",
      "gender": "MALE",
      "bloodGroup": [
        "AB+"
      ],
      "mobileNumber": "text",
      "altContactNumber": "text",
      "email": "[e-mail]",
      "address": [
        "[Circular Reference]"
      ],
      "fatherName": "text",
      "husbandName": "text",
      "relationship": "text",
      "identifiers": [
        {
          "identifierType": "SYSTEM_GENERATED",
          "identifierId": "ABCD-1212"
        }
      ],
      "skills": [
        {
          "type": "text",
          "level": "text",
          "experience": "text"
        }
      ],
      "photo": "text",
      "additionalFields": {
        "schema": "HOUSEHOLD",
        "version": 2,
        "fields": [
          {
            "key": "height",
            "value": 180
          }
        ]
      },
      "rowVersion": 1
    }
  }'

202

400

500

202

{
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "Individual": {
    "id": "text",
    "individualId": "text",
    "tenantId": "tenantA",
    "clientReferenceId": "text",
    "userId": "text",
    "name": {
      "givenName": "text",
      "familyName": "text",
      "otherNames": "text"
    },
    "dateOfBirth": "14/10/2022",
    "gender": "MALE",
    "bloodGroup": [
      "AB+"
    ],
    "mobileNumber": "text",
    "altContactNumber": "text",
    "email": "[e-mail]",
    "address": [
      "[Circular Reference]"
    ],
    "fatherName": "text",
    "husbandName": "text",
    "relationship": "text",
    "identifiers": [
      {
        "identifierType": "SYSTEM_GENERATED",
        "identifierId": "ABCD-1212"
      }
    ],
    "skills": [
      {
        "type": "text",
        "level": "text",
        "experience": "text"
      }
    ],
    "photo": "text",
    "additionalFields": {
      "schema": "HOUSEHOLD",
      "version": 2,
      "fields": [
        {
          "key": "height",
          "value": 180
        }
      ]
    },
    "isDeleted": true,
    "isSystemUser": true,
    "rowVersion": 1,
    "auditDetails": {
      "createdBy": "text",
      "lastModifiedBy": "text",
      "createdTime": 1,
      "lastModifiedTime": 1
    }
  }
}

Accepted

Create/Add Individuals

post

Create a new Individuals

Query parameters

echoResourceanyoptional

Client can specify if the resource in request body needs to be sent back in the response. This is being used to limit amount of data that needs to flow back from the server to the client in low bandwidth scenarios. Server will always send the server generated id for validated requests.

Body

RequestInfoobjectrequired

RequestInfo should be used to carry meta information about the requests to the server as described in the fields below. All eGov APIs will use requestinfo as a part of the request body to carry this meta information. Some of this information will be returned back from the server as part of the ResponseInfo in the response body to ensure correlation.

Individualsobject[] · min: 1optional

A representation of an Individual.

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/individual/v1/bulk/_create' \
  --header 'Content-Type: application/json' \
  --data '{
    "RequestInfo": {
      "apiId": "text",
      "ver": "text",
      "ts": 1,
      "action": "text",
      "did": "text",
      "key": "text",
      "msgId": "text",
      "requesterId": "text",
      "authToken": "text"
    },
    "Individuals": [
      {
        "individualId": "text",
        "tenantId": "tenantA",
        "clientReferenceId": "text",
        "name": {
          "givenName": "text",
          "familyName": "text",
          "otherNames": "text"
        },
        "dateOfBirth": "14/10/2022",
        "gender": "MALE",
        "bloodGroup": [
          "AB+"
        ],
        "mobileNumber": "text",
        "altContactNumber": "text",
        "email": "[e-mail]",
        "address": "[Circular Reference]",
        "fatherName": "text",
        "husbandName": "text",
        "relationship": "text",
        "identifiers": [
          {
            "identifierType": "SYSTEM_GENERATED",
            "identifierId": "ABCD-1212"
          }
        ],
        "skills": [
          {
            "type": "text",
            "level": "text",
            "experience": "text"
          }
        ],
        "photo": "text",
        "additionalFields": {
          "schema": "HOUSEHOLD",
          "version": 2,
          "fields": [
            {
              "key": "height",
              "value": 180
            }
          ]
        },
        "rowVersion": 1,
        "auditDetails": {
          "createdBy": "text",
          "lastModifiedBy": "text",
          "createdTime": 1,
          "lastModifiedTime": 1
        }
      }
    ]
  }'

202

400

500

202

{
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  }
}

Accepted

Update the details of a existing Individual

post

Update the details of a existing Individual

Query parameters

echoResourceanyoptional

Client can specify if the resource in request body needs to be sent back in the response. This is being used to limit amount of data that needs to flow back from the server to the client in low bandwidth scenarios. Server will always send the server generated id for validated requests.

Body

RequestInfoobjectrequired

RequestInfo should be used to carry meta information about the requests to the server as described in the fields below. All eGov APIs will use requestinfo as a part of the request body to carry this meta information. Some of this information will be returned back from the server as part of the ResponseInfo in the response body to ensure correlation.

Individualobjectrequired

A representation of an Individual.

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/individual/v1/_update' \
  --header 'Content-Type: application/json' \
  --data '{
    "RequestInfo": {
      "apiId": "text",
      "ver": "text",
      "ts": 1,
      "action": "text",
      "did": "text",
      "key": "text",
      "msgId": "text",
      "requesterId": "text",
      "authToken": "text"
    },
    "Individual": {
      "individualId": "text",
      "tenantId": "tenantA",
      "clientReferenceId": "text",
      "name": {
        "givenName": "text",
        "familyName": "text",
        "otherNames": "text"
      },
      "dateOfBirth": "14/10/2022",
      "gender": "MALE",
      "bloodGroup": [
        "AB+"
      ],
      "mobileNumber": "text",
      "altContactNumber": "text",
      "email": "[e-mail]",
      "address": [
        "[Circular Reference]"
      ],
      "fatherName": "text",
      "husbandName": "text",
      "relationship": "text",
      "identifiers": [
        {
          "identifierType": "SYSTEM_GENERATED",
          "identifierId": "ABCD-1212"
        }
      ],
      "skills": [
        {
          "type": "text",
          "level": "text",
          "experience": "text"
        }
      ],
      "photo": "text",
      "additionalFields": {
        "schema": "HOUSEHOLD",
        "version": 2,
        "fields": [
          {
            "key": "height",
            "value": 180
          }
        ]
      },
      "rowVersion": 1
    }
  }'

202

400

500

202

{
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "Individual": {
    "id": "text",
    "individualId": "text",
    "tenantId": "tenantA",
    "clientReferenceId": "text",
    "userId": "text",
    "name": {
      "givenName": "text",
      "familyName": "text",
      "otherNames": "text"
    },
    "dateOfBirth": "14/10/2022",
    "gender": "MALE",
    "bloodGroup": [
      "AB+"
    ],
    "mobileNumber": "text",
    "altContactNumber": "text",
    "email": "[e-mail]",
    "address": [
      "[Circular Reference]"
    ],
    "fatherName": "text",
    "husbandName": "text",
    "relationship": "text",
    "identifiers": [
      {
        "identifierType": "SYSTEM_GENERATED",
        "identifierId": "ABCD-1212"
      }
    ],
    "skills": [
      {
        "type": "text",
        "level": "text",
        "experience": "text"
      }
    ],
    "photo": "text",
    "additionalFields": {
      "schema": "HOUSEHOLD",
      "version": 2,
      "fields": [
        {
          "key": "height",
          "value": 180
        }
      ]
    },
    "isDeleted": true,
    "isSystemUser": true,
    "rowVersion": 1,
    "auditDetails": {
      "createdBy": "text",
      "lastModifiedBy": "text",
      "createdTime": 1,
      "lastModifiedTime": 1
    }
  }
}

Accepted

Update the details of existing Individuals

post

Update the details of existing Individuals

Query parameters

echoResourceanyoptional

Client can specify if the resource in request body needs to be sent back in the response. This is being used to limit amount of data that needs to flow back from the server to the client in low bandwidth scenarios. Server will always send the server generated id for validated requests.

Body

RequestInfoobjectrequired

RequestInfo should be used to carry meta information about the requests to the server as described in the fields below. All eGov APIs will use requestinfo as a part of the request body to carry this meta information. Some of this information will be returned back from the server as part of the ResponseInfo in the response body to ensure correlation.

Individualsobject[] · min: 1optional

A representation of an Individual.

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/individual/v1/bulk/_update' \
  --header 'Content-Type: application/json' \
  --data '{
    "RequestInfo": {
      "apiId": "text",
      "ver": "text",
      "ts": 1,
      "action": "text",
      "did": "text",
      "key": "text",
      "msgId": "text",
      "requesterId": "text",
      "authToken": "text"
    },
    "Individuals": [
      {
        "individualId": "text",
        "tenantId": "tenantA",
        "clientReferenceId": "text",
        "name": {
          "givenName": "text",
          "familyName": "text",
          "otherNames": "text"
        },
        "dateOfBirth": "14/10/2022",
        "gender": "MALE",
        "bloodGroup": [
          "AB+"
        ],
        "mobileNumber": "text",
        "altContactNumber": "text",
        "email": "[e-mail]",
        "address": "[Circular Reference]",
        "fatherName": "text",
        "husbandName": "text",
        "relationship": "text",
        "identifiers": [
          {
            "identifierType": "SYSTEM_GENERATED",
            "identifierId": "ABCD-1212"
          }
        ],
        "skills": [
          {
            "type": "text",
            "level": "text",
            "experience": "text"
          }
        ],
        "photo": "text",
        "additionalFields": {
          "schema": "HOUSEHOLD",
          "version": 2,
          "fields": [
            {
              "key": "height",
              "value": 180
            }
          ]
        },
        "rowVersion": 1,
        "auditDetails": {
          "createdBy": "text",
          "lastModifiedBy": "text",
          "createdTime": 1,
          "lastModifiedTime": 1
        }
      }
    ]
  }'

202

400

500

202

{
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  }
}

Accepted

Soft delete the details of a existing Individual and nested entities

post

Soft delete the details of a existing Individual and nested entities

Query parameters

echoResourceanyoptional

Client can specify if the resource in request body needs to be sent back in the response. This is being used to limit amount of data that needs to flow back from the server to the client in low bandwidth scenarios. Server will always send the server generated id for validated requests.

Body

RequestInfoobjectrequired

RequestInfo should be used to carry meta information about the requests to the server as described in the fields below. All eGov APIs will use requestinfo as a part of the request body to carry this meta information. Some of this information will be returned back from the server as part of the ResponseInfo in the response body to ensure correlation.

Individualobjectrequired

A representation of an Individual.

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/individual/v1/_delete' \
  --header 'Content-Type: application/json' \
  --data '{
    "RequestInfo": {
      "apiId": "text",
      "ver": "text",
      "ts": 1,
      "action": "text",
      "did": "text",
      "key": "text",
      "msgId": "text",
      "requesterId": "text",
      "authToken": "text"
    },
    "Individual": {
      "individualId": "text",
      "tenantId": "tenantA",
      "clientReferenceId": "text",
      "name": {
        "givenName": "text",
        "familyName": "text",
        "otherNames": "text"
      },
      "dateOfBirth": "14/10/2022",
      "gender": "MALE",
      "bloodGroup": [
        "AB+"
      ],
      "mobileNumber": "text",
      "altContactNumber": "text",
      "email": "[e-mail]",
      "address": [
        "[Circular Reference]"
      ],
      "fatherName": "text",
      "husbandName": "text",
      "relationship": "text",
      "identifiers": [
        {
          "identifierType": "SYSTEM_GENERATED",
          "identifierId": "ABCD-1212"
        }
      ],
      "skills": [
        {
          "type": "text",
          "level": "text",
          "experience": "text"
        }
      ],
      "photo": "text",
      "additionalFields": {
        "schema": "HOUSEHOLD",
        "version": 2,
        "fields": [
          {
            "key": "height",
            "value": 180
          }
        ]
      },
      "rowVersion": 1
    }
  }'

202

400

500

202

{
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "Individual": {
    "id": "text",
    "individualId": "text",
    "tenantId": "tenantA",
    "clientReferenceId": "text",
    "userId": "text",
    "name": {
      "givenName": "text",
      "familyName": "text",
      "otherNames": "text"
    },
    "dateOfBirth": "14/10/2022",
    "gender": "MALE",
    "bloodGroup": [
      "AB+"
    ],
    "mobileNumber": "text",
    "altContactNumber": "text",
    "email": "[e-mail]",
    "address": [
      "[Circular Reference]"
    ],
    "fatherName": "text",
    "husbandName": "text",
    "relationship": "text",
    "identifiers": [
      {
        "identifierType": "SYSTEM_GENERATED",
        "identifierId": "ABCD-1212"
      }
    ],
    "skills": [
      {
        "type": "text",
        "level": "text",
        "experience": "text"
      }
    ],
    "photo": "text",
    "additionalFields": {
      "schema": "HOUSEHOLD",
      "version": 2,
      "fields": [
        {
          "key": "height",
          "value": 180
        }
      ]
    },
    "isDeleted": true,
    "isSystemUser": true,
    "rowVersion": 1,
    "auditDetails": {
      "createdBy": "text",
      "lastModifiedBy": "text",
      "createdTime": 1,
      "lastModifiedTime": 1
    }
  }
}

Accepted

Soft delete the details of a existing Individual and nested entities in bulk

post

Soft delete the details of a existing Individual and nested entities in bulk

Query parameters

echoResourceanyoptional

Client can specify if the resource in request body needs to be sent back in the response. This is being used to limit amount of data that needs to flow back from the server to the client in low bandwidth scenarios. Server will always send the server generated id for validated requests.

Body

RequestInfoobjectrequired

RequestInfo should be used to carry meta information about the requests to the server as described in the fields below. All eGov APIs will use requestinfo as a part of the request body to carry this meta information. Some of this information will be returned back from the server as part of the ResponseInfo in the response body to ensure correlation.

Individualsobject[] · min: 1optional

A representation of an Individual.

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/individual/v1/bulk/_delete' \
  --header 'Content-Type: application/json' \
  --data '{
    "RequestInfo": {
      "apiId": "text",
      "ver": "text",
      "ts": 1,
      "action": "text",
      "did": "text",
      "key": "text",
      "msgId": "text",
      "requesterId": "text",
      "authToken": "text"
    },
    "Individuals": [
      {
        "individualId": "text",
        "tenantId": "tenantA",
        "clientReferenceId": "text",
        "name": {
          "givenName": "text",
          "familyName": "text",
          "otherNames": "text"
        },
        "dateOfBirth": "14/10/2022",
        "gender": "MALE",
        "bloodGroup": [
          "AB+"
        ],
        "mobileNumber": "text",
        "altContactNumber": "text",
        "email": "[e-mail]",
        "address": "[Circular Reference]",
        "fatherName": "text",
        "husbandName": "text",
        "relationship": "text",
        "identifiers": [
          {
            "identifierType": "SYSTEM_GENERATED",
            "identifierId": "ABCD-1212"
          }
        ],
        "skills": [
          {
            "type": "text",
            "level": "text",
            "experience": "text"
          }
        ],
        "photo": "text",
        "additionalFields": {
          "schema": "HOUSEHOLD",
          "version": 2,
          "fields": [
            {
              "key": "height",
              "value": 180
            }
          ]
        },
        "rowVersion": 1,
        "auditDetails": {
          "createdBy": "text",
          "lastModifiedBy": "text",
          "createdTime": 1,
          "lastModifiedTime": 1
        }
      }
    ]
  }'

202

400

500

202

{
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  }
}

Accepted

Search existing Individual

post

Search existing Individual

Query parameters

limitanyrequired

Pagination - limit records in response

offsetanyrequired

Pagination - offset from which records should be returned in response

tenantIdanyrequired

Unique id for a tenant.

lastChangedSinceanyoptional

epoch of the time since when the changes on the object should be picked up. Search results from this parameter should include both newly created objects since this time as well as any modified objects since this time. This criterion is included to help polling clients to get the changes in system since a last time they synchronized with the platform.

includeDeletedanyoptional

Used in search APIs to specify if (soft) deleted records should be included in search results.

Body

RequestInfoobjectrequired

RequestInfo should be used to carry meta information about the requests to the server as described in the fields below. All eGov APIs will use requestinfo as a part of the request body to carry this meta information. Some of this information will be returned back from the server as part of the ResponseInfo in the response body to ensure correlation.

Individualobjectrequired

A representation of an Individual.

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/individual/v1/_search' \
  --header 'Content-Type: application/json' \
  --data '{
    "RequestInfo": {
      "apiId": "text",
      "ver": "text",
      "ts": 1,
      "action": "text",
      "did": "text",
      "key": "text",
      "msgId": "text",
      "requesterId": "text",
      "authToken": "text"
    },
    "Individual": {
      "individualId": "text",
      "id": [
        "text"
      ],
      "clientReferenceId": [
        "text"
      ],
      "name": {
        "givenName": "text",
        "familyName": "text",
        "otherNames": "text"
      },
      "dateOfBirth": "14/10/2022",
      "gender": "MALE",
      "mobileNumber": "text",
      "socialCategory": "text",
      "identifier": {
        "identifierType": "SYSTEM_GENERATED",
        "identifierId": "ABCD-1212"
      },
      "boundaryCode": "text",
      "wardCode": "text",
      "createdFrom": 1,
      "createdTo": 1
    }
  }'

200

400

500

200

{
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "Individuals": [
    {
      "id": "text",
      "individualId": "text",
      "tenantId": "tenantA",
      "clientReferenceId": "text",
      "userId": "text",
      "name": {
        "givenName": "text",
        "familyName": "text",
        "otherNames": "text"
      },
      "dateOfBirth": "14/10/2022",
      "gender": "MALE",
      "bloodGroup": [
        "AB+"
      ],
      "mobileNumber": "text",
      "altContactNumber": "text",
      "email": "[e-mail]",
      "address": "[Circular Reference]",
      "fatherName": "text",
      "husbandName": "text",
      "relationship": "text",
      "identifiers": [
        {
          "identifierType": "SYSTEM_GENERATED",
          "identifierId": "ABCD-1212"
        }
      ],
      "skills": [
        {
          "type": "text",
          "level": "text",
          "experience": "text"
        }
      ],
      "photo": "text",
      "additionalFields": {
        "schema": "HOUSEHOLD",
        "version": 2,
        "fields": [
          {
            "key": "height",
            "value": 180
          }
        ]
      },
      "isDeleted": true,
      "isSystemUser": true,
      "rowVersion": 1,
      "auditDetails": {
        "createdBy": "text",
        "lastModifiedBy": "text",
        "createdTime": 1,
        "lastModifiedTime": 1
      }
    }
  ]
}

Ok