Rehive logo
Powered by Redocly

document-types

List document types

SecurityapiAuth
Request
query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

Responses
200
get/3/admin/document-types/
Response samples
application/json
{}

Create document type

SecurityapiAuth
Request
Request Body schema:
name
string or null <= 50 characters
description
string or null <= 255 characters
related_resources
Array of strings
Items Enum: "user" "useraddress" "userbankaccount" "userwalletaccount" "usercryptoaccount"
object or null
archived
boolean
Default: false
Responses
201
post/3/admin/document-types/
Request samples
{
  • "name": "string",
  • "description": "string",
  • "related_resources": [
    ],
  • "metadata": {
    },
  • "archived": false
}
Response samples
application/json
{
  • "status": "success",
  • "data": {
    }
}

Retrieve document type

SecurityapiAuth
Request
path Parameters
id
required
string^\d+$
Responses
200
get/3/admin/document-types/{id}/
Response samples
application/json
{
  • "status": "success",
  • "data": {
    }
}

Update document type

SecurityapiAuth
Request
path Parameters
id
required
string^\d+$
Request Body schema:
name
string or null <= 50 characters
description
string or null <= 255 characters
related_resources
Array of strings
Items Enum: "user" "useraddress" "userbankaccount" "userwalletaccount" "usercryptoaccount"
object or null
archived
boolean
Default: false
Responses
200
put/3/admin/document-types/{id}/
Request samples
{
  • "name": "string",
  • "description": "string",
  • "related_resources": [
    ],
  • "metadata": {
    },
  • "archived": false
}
Response samples
application/json
{
  • "status": "success",
  • "data": {
    }
}

Partially update document type

SecurityapiAuth
Request
path Parameters
id
required
string^\d+$
Request Body schema:
name
string or null <= 50 characters
description
string or null <= 255 characters
related_resources
Array of strings
Items Enum: "user" "useraddress" "userbankaccount" "userwalletaccount" "usercryptoaccount"
object or null
archived
boolean
Default: false
Responses
200
patch/3/admin/document-types/{id}/
Request samples
{
  • "name": "string",
  • "description": "string",
  • "related_resources": [
    ],
  • "metadata": {
    },
  • "archived": false
}
Response samples
application/json
{
  • "status": "success",
  • "data": {
    }
}

Delete document type

SecurityapiAuth
Request
path Parameters
id
required
string^\d+$
Responses
200
delete/3/admin/document-types/{id}/
Response samples
application/json
{
  • "status": "sucess"
}
➔ Next to exports