Pular para o conteúdo principal

Marcar arquivo como verificado

POST 
/v1/files/:file/mark-verified

Marca um arquivo como verificado.

Request​

Path Parameters

    file stringrequired

    ID do arquivo

    Example: file_5f92f01728e009f403d8502e

Query Parameters

    expand string

    Expande as referências.

    Pode ser um valor único ou uma lista separada por vírgula (csv) de referências retornadas neste endpoint.

    Example: data.loan
    fields string

    Permite especificar quais campos devem ser incluídos ou excluídos na resposta. Utilize o nome do campo para incluí-lo, ou prefixe o nome com um sinal de menos (-) para excluí-lo. Pode ser um valor único ou uma lista separada por vírgula(csv). Funciona para campos expandidos.

    Esteja ciente de que especificar um campo para inclusão, terá o efeito que nenhum dos campos padrão seja retornado na resposta, a menos que seja explicitamente especificado.

    Importante: Não é permitido combinar inclusões e exclusões na mesma requisição. Uma tentativa de fazê-lo resultará em um erro.

    Examples:

    Retorna apenas os campos `id` e `createdAt`.

    Example: id,createdAt

Header Parameters

    base39-external-client-id string

    Chave de identificação do cliente externo. Utilizada para identificar o cliente que está realizando a requisição.

Responses​

Retorna o objeto File se a mudança de estado for bem-sucedida; retorna erro se os parâmetros forem inválidos.

Schema

    id string

    Identificador exclusivo para o objeto.

    Example: file_63eb84cc5ebbf96915062ecb
    status string[]

    Status do arquivo

    Possible values: [verified, not_verified, denied]

    Default value: not_verified
    Example: verified
    purpose string

    Propósito do arquivo

    Possible values: [account_requirement, org_icon, org_logo, identity_document, additional_verification, selfie, ccb, signature, ccb_signed, insurance, identity_document_front, identity_document_back, pay_stub, proof_of_address, installment, insurance_signature, insurance_signed]

    title string

    Um título amigável para o documento.

    type string

    O tipo do arquivo retornado (csv, pdf, jpg ou png).

    Possible values: [csv, pdf, jpg, png]

    size integer

    O tamanho em bytes do objeto de arquivo.

    publicRead boolean

    Define se o seu arquivo é público ou privado, caso seja público não sera necessário criar um link para download.

    hash

    object

    Informações para legitimar a integridade do arquivo.

    version string

    Versão do arquivo para uma chave do objeto.

    Example: _K9S8UjcthBwQI74hGAF.4WxP56k7JPB
    etag string

    Resultado é um hash MD5 do objeto armazenado.

    Example: c166ebe753806fea4130b6bef70a1229
    sha1 string

    Criptografia do arquivo utilizando o metodo SHA1

    Example: 88368d01f14466bc9065a1ad34252675901ce5a2
    sha512 string

    Criptografia do arquivo utilizando o metodo SHA512

    Example: d261cba960dfe226af30e9f67a34977cee1da52507f90921628436d3bde789679fa7c5498d7ea4d5d1bbb9481b4e03a7eab0d436080bdb781ffb87ba865d216b
    sha256 string

    Criptografia do arquivo utilizando o metodo SHA256

    Example: a56804908e8541628c6b0d781c28760cd45e011975df0f115cbc2aa85f11ff1b
    metadata object

    Conjunto de pares de valores-chave que podem ser anexados a um objeto. Isso pode ser útil para armazenar informações adicionais sobre o objeto em um formato estruturado.

    createdAt date-time

    Data de criação do objeto

    Example: 2023-08-25T22:38:41.134Z
Loading...