Document Types

An API to help you get information about the types of documents allowed for the country you want to work.


GET /documents-type

Request

curl -v --location --request GET 'https://sandbox.smartfastpay.com/documents-type?country=BRA' \
    --header 'Content-Type: application/json' \
    --header 'Authorization: Bearer <Access-Token>' \'

Parameters details

ParameterTypeRequiredDescription

country

string (3) min: 3 | max: 3

yes

This parameter is required. Please, choose a country. Eg.: BRA, COL, ECU ...

Response

{
    "requestId": "167ffff1-b58b-4d1b-909e-ff714c594967",
    "data": [
        {
            "id": 1,
            "abbreviation": "CPF",
            "name": "Cadastro de Pessoa Física"
        },
        {
            "id": 2,
            "abbreviation": "CNPJ",
            "name": "Cadastro Nacional de Pessoa Jurídica"
        },
        {
            "id": 3,
            "abbreviation": "Passaporte",
            "name": "Passaporte"
        },
    ]
}

Response details

ParameterDescription

abbreviation

Acronym for document type abbreviation

name

Document type name

Last updated