BAbankly
Análise de crédito

Consulta de contrato de crédito

<div class="bkly-ref-description"> <p>Consulte um contrato de crédito já existente.</p> <span class="bkly-ref-small-stable-tag">stable</span> <span class="bkly-ref-scope-tag">scope: credit.read</span> </div> [block:callout] { "type": "info", "title": "Nota", "body": "Para mais informações, confira a documentação [Consulta de contrato de crédito](/docs/consulta-contrato-de-credito)." } [/block]
get/cards/credits/document/{documentNumber}/contracts/{contract}

Request

  • Base URL
    https://api-mtls.sandbox.bankly.com.br
  • URL
    https://api-mtls.sandbox.bankly.com.br/cards/credits/document/{documentNumber}/contracts/{contract}
  • Auth
    HTTP bearer

Path parameters

documentNumberstring required

Número do documento do cliente (CPF ou CNPJ).

contractstring required

Número do contrato de crédito do cliente.

Parameters

#/paths/~1cards~1credits~1customers/post/parameters/0 (unresolved $ref)
#/paths/~1cards~1credits~1customers/post/parameters/1 (unresolved $ref)

Response

A solicitação foi aceita e trará um objeto contendo informações sobre o contrato de crédito.

namestring

Nome completo do cliente.

socialNamestring

Nome pelo qual a pessoa gostaria de ser chamada. Saiba mais consultando a Cartilha do nome social.

motherNamestring

Nome da mãe do cliente.

birthDatestring date-time

Data de nascimento do cliente.

programIdstring

Identificador do programa que será vinculado ao cartão.

documentNumberstring

Número de documento do cliente (CPF ou CNPJ).

professionstring

Profissão do cliente.

cardProxystring

Proxy do cartão.

status'Pending' | 'Approved' | 'Reproved' | 'Canceled' | 'Expired' | 'Signed' | 'Blocked'
contractstring

Número do contrato de crédito.

maritalStatus'Single' | 'Married' | 'Separated' | 'Divorced' | 'Widower'

Estado civil do cliente.

academicDegree'HighSchool' | 'Graduated' | 'PostGraduate' | 'Masters' | 'Doctorate'

Grau de instrução do cliente.

incomeBracket'LessThousand' | 'FromThousandToTwoThousand' | 'FromTwoThousandToThreeThousand' | 'FromThreeThousandToFiveThousand' | 'FromFiveThousandToTenThousand' | 'FromTenThousandToTwentyThousand' | 'OverTwentyThousand'

Faixa salarial do cliente.

incomeBracketRangenumber

Valor intermediário da faixa salarial do cliente.

expirationDatestring date-time

Data de expiração da proposta de crédito.

sex'Male' | 'Female' | 'Other'

Gênero do cliente.

emailstring email

Endereço de e-mail do cliente.

Changes

No recorded changes to this operation across all 1 revision of this API.