Get Document Type List

GET : http://<base_url>/digipay/v3/user/document_type

This API is used to get a document type detail into the system

QUERY PARAMS:-

Parameter	Type	Description	Value
document_type_title	String	The title or name of the document type, such as ""Passport"" or ""Driver's License.	selfish
document_user_type	Int	Represents the user type associated with the document, like different roles or permissions	2
document_side_type	Int	Denotes the type of document side (front, back, both) that is being referred to.	1
is_mandatory	Boolean	A boolean flag indicating whether the document is mandatory.	true/false
document_type	Int	Represents the type or classification of the document.	1
document_category	Int	Denotes the category to which the document belongs.	2
dynamic_category_key	String	A key that dynamically links documents to specific categories.	dynamic_key
expiry_date_required	Boolean	A boolean flag indicating whether an expiry date is required for the document."	true/false
skip	Int	Skip the first n document from the query result	1
limit	Int	Limits the number of records or documents that you want	1
start_date	long	unix timestamp value in second	1
end_date	Long	unix timestamp value in second	1
sorting	Long	Sorting of the Data in the form of a string	123
search_keyword	String	a keyword is either name of user compalits logs to search	123

HEADERS:-

Parameter	Type	Description	value
Authorization	String	It is a combination of type and token to authenticate user for the given token	Token duik7309njdlkhdauhknksadhjkas986876sd873j
CompanyID	String	Company_id is a unique primary id, that is represent company detail	76bc712200ca444fa334f9e55e5fd7a8

Request Body:-

Request Example
curl --request GET \
     --url 'http://192.168.1.102:8014/digipay/v3/user/document_type?document_type=2&user_type=2&dynamic_category_key=dynamic_key&document_category=2&expiry_date_required=false&business_types=%5B%22%22type1%22%22&business_types=%22%22type2%22%22%5D&business_types=&skip=1&limit=1&is_active=false&start_date=1&end_date=1&sorting=123&search_keyword=123' \
     --header 'Authorization: Token eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOiI2NWY0ZDI1MDliZmU0NTBmYTg4MTVhNTU5Njk3YmM0NyIsInJvbGVzIjpbIlJPTEVfQURNSU4iXSwiZXhwIjoxNjkzNTIxOTU1fQ.9oWwUzlFzmYB1ZOhaVamxKJH6DsMO8tFue2kbg2YyoI' \
     --header 'CompanyID: 76bc712200ca444fa334f9e55e5fd7a8' \
     --header 'accept: application/json'

Response:-

Response 200(OK)

{
    "success": 1,
    "error": [],
    "data": {
        "document_type": [
            {
                "id": "b9a4cbeeedd340509cb1ac628cae2973",
                "document_type_title": "Selfie",
                "document_user_type": 2,
                "document_side_type": 1,
                "is_mandatory" : false,
                "document_extra_fields": [
                    "key1",
                    "key2"
                ],
                "document_type" : 1,  
                "document_group": 1 
            }
        ]
    }
}

Response 400(BAD REQUEST)
{
    "success": 0,
    "error"": [1],
    "data": {
        "message": "BAD_REQUEST",
     }
}

RESPONSES :-

Status Code	Description
200	OK
400	Bad Request
404	Not Found
500	Internal Server Error