Types
GET
https://leads.qreq.com/api/document-types
curl --request GET \
--url 'https://leads.qreq.com/api/document-types' \
--header 'Authorization: Bearer {api_key}'
--url 'https://leads.qreq.com/api/document-types' \
--header 'Authorization: Bearer {api_key}'
{
"status": "success",
"message": "Document types retrieved successfully.",
"data": [
{
"id": 1,
"name": "Passport",
"description": "Identity verification document",
"status": "active",
"created_by": 33,
"created_at": "2025-11-03T08:00:00.000000Z",
"updated_at": "2025-11-03T08:00:00.000000Z"
},
{
"id": 2,
"name": "Utility Bill",
"description": "Proof of residence",
"status": "inactive",
"created_by": 33,
"created_at": "2025-11-03T09:10:00.000000Z",
"updated_at": "2025-11-03T09:15:00.000000Z"
}
]
}
GET
https://leads.qreq.com/api/document-types/{type_id}
curl --request GET \
--url 'https://leads.qreq.com/api/document-types/{type_id}' \
--header 'Authorization: Bearer {api_key}'
--url 'https://leads.qreq.com/api/document-types/{type_id}' \
--header 'Authorization: Bearer {api_key}'
{
"status": "success",
"message": "Document type retrieved successfully.",
"data": {
"id": 1,
"name": "Passport",
"description": "Identity verification document",
"status": "active",
"created_by": 33,
"created_at": "2025-11-03T08:00:00.000000Z",
"updated_at": "2025-11-03T08:00:00.000000Z"
}
}
POST
https://leads.qreq.com/api/document-types
| Parameter | Einzelheiten | Beschreibung |
|---|---|---|
| name | ErforderlichZeichenfolge | Document type name (e.g., "Passport") |
| description | OptionalZeichenfolge | Description of document type |
| status | OptionalZeichenfolge | Status of document type (active/inactive) |
curl --request POST \
--url 'https://leads.qreq.com/api/document-types' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: application/json' \
--data-raw '{ "name": "Driver License", "description": "Government-issued driving license", "status": "active" }'
--url 'https://leads.qreq.com/api/document-types' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: application/json' \
--data-raw '{ "name": "Driver License", "description": "Government-issued driving license", "status": "active" }'
{
"status": "success",
"message": "Document type created successfully.",
"data": {
"id": 3,
"name": "Driver License",
"description": "Government-issued driving license",
"status": "active",
"created_by": 33,
"created_at": "2025-11-03T09:20:00.000000Z",
"updated_at": "2025-11-03T09:20:00.000000Z"
}
}
PUT
https://leads.qreq.com/api/document-types/{type_id}
curl --request PUT \
--url 'https://leads.qreq.com/api/document-types/{type_id}' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: application/json' \
--data-raw '{ "name": "Updated Type", "description": "Updated description", "status": "inactive" }'
--url 'https://leads.qreq.com/api/document-types/{type_id}' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: application/json' \
--data-raw '{ "name": "Updated Type", "description": "Updated description", "status": "inactive" }'
{
"status": "success",
"message": "Document type updated successfully.",
"data": {
"id": 3,
"name": "Updated Type",
"description": "Updated description",
"status": "inactive",
"updated_at": "2025-11-03T09:25:00.000000Z"
}
}
DELETE
https://leads.qreq.com/api/document-types/{type_id}
curl --request DELETE \
--url 'https://leads.qreq.com/api/document-types/{type_id}' \
--header 'Authorization: Bearer {api_key}'
--url 'https://leads.qreq.com/api/document-types/{type_id}' \
--header 'Authorization: Bearer {api_key}'
{
"status": "success",
"message": "Document type deleted successfully."
}