Document APIs
This section contains detail about the service APIs for Document Master data.
Documents Categories APIs These APIs include create, update, fetch, search and filter which are used by the administrator portal. Create and update APIs are used for the create and updating document category functionality. Search API is used by the portal to fetch the list of document categories based on a filter criterion to display the list of document categories on the UI and filter API is used to populate document category filter drop-downs on the portal UI. Fetch API of document category are used by Pre-Registration UI to display the list of document categories for the applicant to view and by the ID Object validator to validate the document category received in the packet in Registration processor.
Documents Types APIs These APIs include create, update, fetch, search and filter which are used by the administrator portal. Create and update APIs are used for the create and update document type functionality. Search API is used by the portal to fetch the list of document types based on a filter criterion to display the list of document types on the UI and filter API is used to populate document types filter drop-downs on the portal UI. Fetch API of document type is used by Pre-Registration UI to display the list of document types for the applicant to view and select and by the ID Object validator to validate the document type received in the packet in Registration processor.
Valid Documents API These APIs includes the map, unmap, search and filter which are used by the administrator portal. Map and un-map APIs are used by the portal to create and remove mapping of document category and document type. Search API is used by the portal to fetch the mappings of document categories and document types based on a filter criterion to display the list of mappings on the UI. Filter API is used to populate document mappings filter drop-downs on the portal UI.
Documents Category
POST /documentcategories
This service will create the list of Documents Category which are used in the MOSIP platform.
Resource URL
POST /documentcategories
Resource details
Parameters
Example Request
Example Response
Response code: 200 Ok
PUT/documentcategories
This service will create the list of Documents Category which are used in the MOSIP platform.
Resource URL
PUT /documentcategories
Resource details
Parameters
Example Request
Example Response
Response code: 200 Ok
GET /documentcategories
This service will provides the service for the List of documents categories.
Resource URL
GET /documentcategories
Resource details
Parameters
Example Response
Response code: 200 Ok
GET /documentcategories/{code}/{langcode}
This service will provides the service for the List of documents categories.
Resource URL
GET /documentcategories/{code}/{langcode}
Resource details
Parameters
Example Response
Response code: 200 Ok
GET /documentcategories/{langcode}
This service will provides the service for the List of documents categories based on the passed langcode.
Resource URL
GET /documentcategories/{langcode}
Resource details
Parameters
Example Response
Response code: 200 Ok
DELETE /documentcategories/{code}
This service will provides the service to delete documents categories based on the passed given code.
Resource URL
DELETE /documentcategories/{code}
Resource details
Parameters
Example Response
Response code: 200 Ok
POST /documentcategories/search
This service is for the registration centers search functionality. All the filter parameters are passed and the Documents Category are searched and the matching results are returned.
Resource URL
POST /documentcategories/search
Resource details
Parameters
Filter Values
Please find the filter columns used in search
Name
Status
Example Request
Example Response
Response code: 200 Ok
POST /documentcategories/filtervalues
This service returns the filter values which are required in the dropdown entries of the filter screen.
Resource URL
POST /documentcategories/filtervalues
Resource details
Parameters
Example Request
Example Response
Response code: 200 Ok
Failure Response
Response code: 200 Ok
Failure details
Documents Types
POST /documenttype
This service will create the list of Documents types which are used in the MOSIP platform. There is another service to map the document category and document type. Please find the steps to create primary/secondary languages in this link.
Resource URL
POST /documenttype
Resource details
Parameters
Example Request
Example Response
Response code: 200 Ok
Error Response
Response code: 200 Ok
Failure details
PUT /documenttype
This service will update the list of Documents types which are used in the MOSIP platform.
Resource URL
PUT /documenttype
Resource details
Parameters
Example Request
Example Response
Response code: 200 Ok
Error Response
Response code: 200 Ok
Failure details
GET /documenttypes/{documentcategorycode}/{langcode}
This service will provides the service for the valid doucment type avialbale for specific Document Category code
Resource URL
GET /documenttypes/{documentcategorycode}/{langcode}
Resource details
Parameters
Example Response
Response code: 200 Ok
GET /documentcategorytypes
This service will provides the service for the List of documents types.
Resource URL
GET /documentcategorytypes
Resource details
Parameters
Example Request
-NA-
Example Response
Response code: 200 Ok
GET /doccattypes
This service will give back the document category and it's corresponding category types based on Individual type code, Age group type code and Gender type code.
Resource URL
GET /doccattypes
Resource details
Parameters
Example Request
Example Response
Response code: 200 Ok
GET /checkapptypedoccattypedoctype
This service checks the mapping between the Applicant type code, Document category and the Document type mapping. Result message will be success, if the mapping exists.
Resource URL
GET /checkapptypedoccattypedoctype
Resource details
Parameters
Example Request
Example Response
Response code: 200 Ok
POST /documenttypes/search
This service is for the document type search functionality. All the filter parameters are passed and the document type are searched and the matching results are returned.
Resource URL
POST /documenttypes/search
Resource details
Parameters
Filter Values
Example Request
Example Response
Response code: 200 Ok
POST /documenttypes/filtervalues
This service returns the filter values which are required in the dropdown entries of the filter screen.
Resource URL
POST /documenttypes/filtervalues
Resource details
Parameters
Example Request
Example Response
Response code: 200 Ok
Failure details
Valid documents
GET /validdocuments/{languagecode}
This API fetches all the valid documents based on language code.
Resource URL
GET /validdocuments/{languagecode}
Resource details
Parameters
Example Request
Example Success Response
Response code: 200 Ok
Example Failure Response
Response code: 200 Ok
GET /validdocuments/{languagecode}
Resource URL
GET /validdocuments/{docCategoryCode}/{languagecode}
Resource details
Parameters
Example Request
Example Success Response
Response code: 200 Ok
Example Failure Response
Response code: 200 Ok
POST /validdocuments/search
This service is for the valid document search functionality. All the filter parameters are passed and the valid document are searched and the matching results are returned.
Resource URL
POST /validdocuments/search
Resource details
Parameters
Example Request
Example Response
Response code: 200 Ok
POST /validdocuments/filtervalues
This service returns the filter values which are required in the dropdown entries of the filter screen.
Resource URL
POST /validdocuments/filtervalues
Resource details
Parameters
Example Request
Example Response
Response code: 200 Ok
Failure details
POST /validdocuments/map/{doccategorycode}/{doctypecode}
This service is for the valid document mapping category with document category with document type code.
Resource URL
POST /validdocuments/map/{doccategorycode}/{doctypecode}
Resource details
Parameters
Example Request
Success Response
Response code: 200 Ok
Error Response
Response code: 200 Ok
Failure details
PUT /validdocuments/unmap/{doccategorycode}/{doctypecode}
This service is used for the un-mapping document category with document type code.
Resource URL
PUT /validdocuments/unmap/{doccategorycode}/{doctypecode}
Resource details
Parameters
Example Request
Success Response
Response code: 200 Ok
Error Response
Response code: 200 Ok
Failure details
Last updated