DIGIT Specifications
PlatformUrbanHealthPublic FinanceSanitation
  • Specifications Overview
    • Standardisation Approach
  • Common Service Specs
    • Access Control
    • Analytics
    • Billing
    • Collection
    • Dashboard Analytics
    • Decision Support System Ingest
    • Document Controller
    • Employee
    • Encryption
    • Filestore
    • ID Generation
    • Inbox
    • Indexer
    • Master
    • Master Data Management
    • OTP
    • Payment Gateway
    • PDF Generation
    • URL Shortening
    • User
    • Workflow
  • Domain Service Specs
    • Attendance
    • Bank Account
    • Billing Calculator
    • Birth-Death
    • Building Plan Approval
    • Building Plan Calculator
    • Campaign
    • Campaign Delivery
    • Contracts
    • Estimates
    • eChallan
    • Facility
    • Faecal Sludge Management (FSM)
    • Fire NOC
    • Fire NOC Calculator
    • Household
    • Individual
    • Inventory
    • Land
    • Muster Roll
    • National Dashboard Ingest
    • No Objection Certificate
    • Organization
    • Planning
    • Product
    • Project
    • Property Registry
    • Property Tax Calculator
    • Public Grievance Redressal
    • Registration
    • Sewerage Connection
    • Stock
    • Supervision
    • Sync
    • Trade Licence
    • Trade Licence Calculator
    • User Events
    • Vehicle Registration
    • Vendor Registration
    • Water Connection
  • Archived-docs
    • DIGIT Urban Service Specs
      • Property Tax Service
        • Property Tax Taxonomy
        • Property Tax Data Model
        • Property Tax Service API
      • Public Grievance Redressal Service
        • Public Grievance Redressal Taxonomy
        • Public Grievance Redressal Data Model
        • Public Grievance Redressal Service API
      • Trade License Service
        • Trade License Taxonomy
        • Trade License Data Model
        • Trade License API
      • Fire NOC Service
        • Fire NOC Taxonomy
        • Fire NOC Data Model
        • Fire NOC API
      • Miscellaneous Collection Service
        • Miscellaneous Collections Taxonomy
        • Miscellaneous Collections Data Model
        • Miscellaneous Collection API
      • Online Building Plan Approval Service
        • Online Building Plan Approval Taxonomy
        • Online Building Plan Approval Data Model
        • Online Building Plan Approval Service API
      • Water & Sewerage Service
        • Water & Sewerage Taxonomy
        • Water Service Data Model
        • Sewerage Service Data Model
        • Water & Sewerage Service API
      • Birth & Death Service
        • Birth & Death Taxonomy
        • Birth & Death Data Model
        • Birth & Death Service API
    • DIGIT Public Finance Management Service Specs
      • iFIX Master Data Service API
      • Adapter Master Data Service API
      • mGramSeva iFIX Adapter Service API
      • iFIX Department Entity Service API
      • Fiscal Event API
    • DIGIT Health Service Specs
      • Health Service Data Model
      • Health Service API
    • DIGIT Sanitation Service Specs
      • Faecal Sludge Management Service
        • Faecal Sludge Management Data Model
        • Faecal Sludge Management Service API
Powered by GitBook

โ€‹All content on this page by eGov Foundation is licensed under a Creative Commons Attribution 4.0 International License.

On this page

Was this helpful?

Export as PDF
  1. Domain Service Specs

Individual

PreviousHouseholdNextInventory

Last updated 1 year ago

Was this helpful?

Individual Registry

Maintain and manage individual registries.

  • Individual Registry
  • POSTCreate/Add a new Individual
  • POSTCreate/Add Individuals
  • POSTUpdate the details of a existing Individual
  • POSTUpdate the details of existing Individuals
  • POSTSoft delete the details of a existing Individual and nested entities
  • POSTSoft delete the details of a existing Individual and nested entities in bulk
  • POSTSearch existing Individual

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
Responses
202
Accepted
application/json
400
Bad Request
application/json
500
Internal Server Error
application/json
post
POST /individual/v1/_create HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 1149

{
  "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": "name@gmail.com",
    "address": [
      {
        "tenantId": "tenantA",
        "doorNo": "text",
        "latitude": 1,
        "longitude": 1,
        "locationAccuracy": 1,
        "type": [
          "PERMANENT"
        ],
        "addressLine1": "text",
        "addressLine2": "text",
        "landmark": "text",
        "city": "text",
        "pincode": "text",
        "buildingName": "text",
        "street": "text",
        "locality": {
          "code": "text",
          "name": "text",
          "label": "text",
          "latitude": "text",
          "longitude": "text",
          "children": [
            "[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
  }
}
{
  "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": "name@gmail.com",
    "address": [
      {
        "id": "text",
        "tenantId": "tenantA",
        "doorNo": "text",
        "latitude": 1,
        "longitude": 1,
        "locationAccuracy": 1,
        "type": [
          "PERMANENT"
        ],
        "addressLine1": "text",
        "addressLine2": "text",
        "landmark": "text",
        "city": "text",
        "pincode": "text",
        "buildingName": "text",
        "street": "text",
        "locality": {
          "code": "text",
          "name": "text",
          "label": "text",
          "latitude": "text",
          "longitude": "text",
          "children": [
            "[Circular Reference]"
          ],
          "materializedPath": "text"
        }
      }
    ],
    "fatherName": "text",
    "husbandName": "text",
    "relationship": "text",
    "identifiers": [
      {
        "identifierType": "SYSTEM_GENERATED",
        "identifierId": "ABCD-1212"
      }
    ],
    "skills": [
      {
        "id": "text",
        "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
    }
  }
}

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
Responses
202
Accepted
application/json
400
Bad Request
application/json
500
Internal Server Error
application/json
post
POST /individual/v1/bulk/_create HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 1150

{
  "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": "name@gmail.com",
      "address": [
        {
          "tenantId": "tenantA",
          "doorNo": "text",
          "latitude": 1,
          "longitude": 1,
          "locationAccuracy": 1,
          "type": [
            "PERMANENT"
          ],
          "addressLine1": "text",
          "addressLine2": "text",
          "landmark": "text",
          "city": "text",
          "pincode": "text",
          "buildingName": "text",
          "street": "text",
          "locality": {
            "code": "text",
            "name": "text",
            "label": "text",
            "latitude": "text",
            "longitude": "text",
            "children": "[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
    }
  ]
}
{
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  }
}

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
Responses
202
Accepted
application/json
400
Bad Request
application/json
500
Internal Server Error
application/json
post
POST /individual/v1/_update HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 1149

{
  "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": "name@gmail.com",
    "address": [
      {
        "tenantId": "tenantA",
        "doorNo": "text",
        "latitude": 1,
        "longitude": 1,
        "locationAccuracy": 1,
        "type": [
          "PERMANENT"
        ],
        "addressLine1": "text",
        "addressLine2": "text",
        "landmark": "text",
        "city": "text",
        "pincode": "text",
        "buildingName": "text",
        "street": "text",
        "locality": {
          "code": "text",
          "name": "text",
          "label": "text",
          "latitude": "text",
          "longitude": "text",
          "children": [
            "[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
  }
}
{
  "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": "name@gmail.com",
    "address": [
      {
        "id": "text",
        "tenantId": "tenantA",
        "doorNo": "text",
        "latitude": 1,
        "longitude": 1,
        "locationAccuracy": 1,
        "type": [
          "PERMANENT"
        ],
        "addressLine1": "text",
        "addressLine2": "text",
        "landmark": "text",
        "city": "text",
        "pincode": "text",
        "buildingName": "text",
        "street": "text",
        "locality": {
          "code": "text",
          "name": "text",
          "label": "text",
          "latitude": "text",
          "longitude": "text",
          "children": [
            "[Circular Reference]"
          ],
          "materializedPath": "text"
        }
      }
    ],
    "fatherName": "text",
    "husbandName": "text",
    "relationship": "text",
    "identifiers": [
      {
        "identifierType": "SYSTEM_GENERATED",
        "identifierId": "ABCD-1212"
      }
    ],
    "skills": [
      {
        "id": "text",
        "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
    }
  }
}

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
Responses
202
Accepted
application/json
400
Bad Request
application/json
500
Internal Server Error
application/json
post
POST /individual/v1/bulk/_update HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 1150

{
  "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": "name@gmail.com",
      "address": [
        {
          "tenantId": "tenantA",
          "doorNo": "text",
          "latitude": 1,
          "longitude": 1,
          "locationAccuracy": 1,
          "type": [
            "PERMANENT"
          ],
          "addressLine1": "text",
          "addressLine2": "text",
          "landmark": "text",
          "city": "text",
          "pincode": "text",
          "buildingName": "text",
          "street": "text",
          "locality": {
            "code": "text",
            "name": "text",
            "label": "text",
            "latitude": "text",
            "longitude": "text",
            "children": "[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
    }
  ]
}
{
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  }
}

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
Responses
202
Accepted
application/json
400
Bad Request
application/json
500
Internal Server Error
application/json
post
POST /individual/v1/_delete HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 1149

{
  "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": "name@gmail.com",
    "address": [
      {
        "tenantId": "tenantA",
        "doorNo": "text",
        "latitude": 1,
        "longitude": 1,
        "locationAccuracy": 1,
        "type": [
          "PERMANENT"
        ],
        "addressLine1": "text",
        "addressLine2": "text",
        "landmark": "text",
        "city": "text",
        "pincode": "text",
        "buildingName": "text",
        "street": "text",
        "locality": {
          "code": "text",
          "name": "text",
          "label": "text",
          "latitude": "text",
          "longitude": "text",
          "children": [
            "[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
  }
}
{
  "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": "name@gmail.com",
    "address": [
      {
        "id": "text",
        "tenantId": "tenantA",
        "doorNo": "text",
        "latitude": 1,
        "longitude": 1,
        "locationAccuracy": 1,
        "type": [
          "PERMANENT"
        ],
        "addressLine1": "text",
        "addressLine2": "text",
        "landmark": "text",
        "city": "text",
        "pincode": "text",
        "buildingName": "text",
        "street": "text",
        "locality": {
          "code": "text",
          "name": "text",
          "label": "text",
          "latitude": "text",
          "longitude": "text",
          "children": [
            "[Circular Reference]"
          ],
          "materializedPath": "text"
        }
      }
    ],
    "fatherName": "text",
    "husbandName": "text",
    "relationship": "text",
    "identifiers": [
      {
        "identifierType": "SYSTEM_GENERATED",
        "identifierId": "ABCD-1212"
      }
    ],
    "skills": [
      {
        "id": "text",
        "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
    }
  }
}

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
Responses
202
Accepted
application/json
400
Bad Request
application/json
500
Internal Server Error
application/json
post
POST /individual/v1/bulk/_delete HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 1150

{
  "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": "name@gmail.com",
      "address": [
        {
          "tenantId": "tenantA",
          "doorNo": "text",
          "latitude": 1,
          "longitude": 1,
          "locationAccuracy": 1,
          "type": [
            "PERMANENT"
          ],
          "addressLine1": "text",
          "addressLine2": "text",
          "landmark": "text",
          "city": "text",
          "pincode": "text",
          "buildingName": "text",
          "street": "text",
          "locality": {
            "code": "text",
            "name": "text",
            "label": "text",
            "latitude": "text",
            "longitude": "text",
            "children": "[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
    }
  ]
}
{
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  }
}

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
Responses
200
Ok
application/json
400
Bad Request
application/json
500
Internal Server Error
application/json
post
POST /individual/v1/_search?limit=null&offset=null&tenantId=null HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 534

{
  "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
  }
}
{
  "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": "name@gmail.com",
      "address": [
        {
          "id": "text",
          "tenantId": "tenantA",
          "doorNo": "text",
          "latitude": 1,
          "longitude": 1,
          "locationAccuracy": 1,
          "type": [
            "PERMANENT"
          ],
          "addressLine1": "text",
          "addressLine2": "text",
          "landmark": "text",
          "city": "text",
          "pincode": "text",
          "buildingName": "text",
          "street": "text",
          "locality": {
            "code": "text",
            "name": "text",
            "label": "text",
            "latitude": "text",
            "longitude": "text",
            "children": "[Circular Reference]",
            "materializedPath": "text"
          }
        }
      ],
      "fatherName": "text",
      "husbandName": "text",
      "relationship": "text",
      "identifiers": [
        {
          "identifierType": "SYSTEM_GENERATED",
          "identifierId": "ABCD-1212"
        }
      ],
      "skills": [
        {
          "id": "text",
          "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
      }
    }
  ]
}