Consultar um Funding

Esse endpoint permite consultar um determinado Financiador (funding).

Parâmetros da Requisição

Não é necessário o envio de nenhum dado no corpo da requisição.

Parâmetros da URL (opcionais)

• funding_id (string/uuid v4) : Identificador do cadastro do Financiador.

Resposta

Se a requisição for processada com sucesso será retornado um status 200 e um JSON com o seguinte formato

• id (string uuid): Identificador único do cadastro do Funding.

• taxpayer_id (string): O nº do CNPJ da empresa.

• legal_name (string): A razão social da empresa.

• alias (string): O nome fantasia da empresa.

• email_address(string): Campo do e-mail para contato com a Empresa.

• phone(objeto): Objeto contendo o número do telefone para contato com a empresa.

  • area_code(string): Campo do código da área (DDD).

  • country_code(string): Código Internacional para identificação do país (DDI).

  • number(string): Número do telefone, somente os números.

  • formatted_number(string): Número do telefone formatado.

• address(objeto): Objeto contendo os dados do endereço da Empresa.

  • street_name(string): Nome do logradouro do endereço.

  • street_number(integer): Númeração do endereço.

  • extra_info(string): Campo de dados adicionais, complemento, do Endereço.

  • district(string): Bairro do endereço.

  • city(string): Cidade do endereço.

  • postal_code (string): Código de CEP para o endereço.

  • state_code(string): Sigla para identificação do estado/uf.

  • country_code(string): Código do país.

• created_at : Data e hora que o registro do Funding foi criado.

• updated_at : Data e hora da última atualização.

• version : Identificador da versão do cadastro do Financiador.

Exemplo de JSON:

{
    "id": "<uuid>",
    "legal_name": "<string>",
    "taxpayer_id": "<string>",
    "phone": {
        "area_code": "<string>",
        "country_code": "<string>",
        "number": "<string>",
        "formatted_number": "<string>"
    },
    "email_address": "<string>",
    "address": {
        "city": "<string>",
        "country_code": "<string>",
        "district": "<string>",
        "postal_code": "38872206",
        "state_code": "<string>",
        "street_name": "<string>",
        "street_number": "<integer>",
        "extra_info": "<string>"
    },
    "relations": [
        {
            "person": {
                "id": "<uuid>",
                "full_name": "<string>",
                "taxpayer_id": "<string>"
            },
            "signer": "<boolean>"
        },
        {
            "person": {
                "id": "<uuid>",
                "full_name": "<string>",
                "taxpayer_id": "<string>"
            },
            "signer": "<boolean>"
        }
    ],
    "metadata": {
        "values": {
            "aliqua_7": {
                "value": [
                    "<string>",
                    "<string>"
                ],
                "sensitive": "<boolean>"
            }
        }
    },
    "created_at": "<dateTime>",
    "updated_at": "<dateTime>",
    "version": "<integer>",
    "alias": "<string>"
}