Tipos de Documento

Este recurso muestra el identificador, nombre y código de los documentos de identificación previamente creados en la aplicación.

En la API v3 de Sperant se podrá Listar Tipos de documentos y mostrar un tipo de documento determinado:

Listar tipos de documentos

GET https://api.sperant.com/v3/document_types

Permite listar todos los tipos de documentos registrados en el sistema:

Path Parameters

Name
Type
Description

Authorization

string

Token entregado.

{
    "data": [
        {
            "type": "document_types",
            "id": "4",
            "attributes": {
                "id": 4,
                "code": "PASSPORT",
                "name": "Pasaporte"
            }
        },
        {
            "type": "document_types",
            "id": "3",
            "attributes": {
                "id": 3,
                "code": "RUC",
                "name": "RUC"
            }
        },
        {
            "type": "document_types",
            "id": "2",
            "attributes": {
                "id": 2,
                "code": "INMIGRATIONCARD",
                "name": "Carné de Extranjería"
            }
        },
        {
            "type": "document_types",
            "id": "1",
            "attributes": {
                "id": 1,
                "code": "DNI",
                "name": "DNI"
            }
        }
    ]
}

Parámetros de retorno

Parámetro

Tipo de Dato

Descripción

id

integer

Identificador del tipo de documento.

code

string

Código del tipo de documento.

name

string

Nombre del tipo de documento.

Mostrar tipo de documento

GET https://api.sperant.com/v3/document_types/<id>

Permite mostrar un tipo de documento determinado:

Path Parameters

Name
Type
Description

Authorization

string

Token entregado.

{
    "data": {
        "type": "document_types",
        "id": "1",
        "attributes": {
            "id": 1,
            "code": "DNI",
            "name": "DNI"
        }
    }
}

Parámetros de retorno

Parámetro

Tipo de Dato

Descripción

id

integer

Identificador del tipo de documento.

code

string

Código del tipo de documento.

name

string

Nombre del tipo de documento.

Última actualización