--- title: "Consulta de contrato de crédito" method: GET path: "/cards/credits/document/{documentNumber}/contracts/{contract}" tags: ["Análise de crédito"] --- # Consulta de contrato de crédito `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

Consulte um contrato de crédito já existente.

stable scope: credit.read
[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] ## Path parameters - `documentNumber` string, required: Número do documento do cliente (CPF ou CNPJ). - `contract` string, 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 `202` A solicitação foi aceita e trará um objeto contendo informações sobre o contrato de crédito. - GetContractCreditResponse - `name` string: Nome completo do cliente. - `socialName` string: Nome pelo qual a pessoa gostaria de ser chamada. Saiba mais consultando a [Cartilha do nome social](https://www.mds.gov.br/webarquivos/publicacao/assistencia_social/Folders/cartilha_nome_social.pdf). - `motherName` string: Nome da mãe do cliente. - `birthDate` string, date-time: Data de nascimento do cliente. - `programId` string: Identificador do programa que será vinculado ao cartão. - `documentNumber` string: Número de documento do cliente (CPF ou CNPJ). - `profession` string: Profissão do cliente. - `cardProxy` string: Proxy do cartão. - `status` 'Pending' | 'Approved' | 'Reproved' | 'Canceled' | 'Expired' | 'Signed' | 'Blocked' - `contract` string: 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. - `incomeBracketRange` number: Valor intermediário da faixa salarial do cliente. - `expirationDate` string, date-time: Data de expiração da proposta de crédito. - `sex` 'Male' | 'Female' | 'Other': Gênero do cliente. - `email` string, email: Endereço de e-mail do cliente. - `address` Address: Objeto que contém informações sobre o endereço do cliente. - `zipCode` string: Código postal de endereço. - `addressLine` string: Logradouro (nome da rua, avenida etc.). - `buildingNumber` string: Número do imóvel. - `complement` string: Complemento do endereço. - `neighborhood` string: Nome do bairro ou distrito. - `city` string: Nome da cidade. - `state` string: Sigla do estado brasileiro conforme a ISO 3166-2:BR. - `country` string: País do endereço. - `phone` object: Objeto que contém informações sobre o telefone do cliente. - `type` 'Residential' | 'Commercial' | 'Mobile': Tipo de telefone do cliente. - `value` string: Número do telefone do cliente. - `countryCode` string: Código DDI do país. - `creditEvaluation` object: Objeto que contém informações sobre a análise de crédito. - `status` 'Approved' | 'Reproved' - `evaluatedAt` string, date-time: Data em que ocorreu a avaliação. - `reasonRefusal` string: Motivo de reprovação. - `policy` string: Política utilizada na avaliação. - `acceptanceTerm` AcceptanceTerm: Objeto que contém informações sobre o termo de aceite do cliente. - `signedAt` string: Data e hora em que o contrato de crédito foi aceito/assinado. - `creditDetails` object: Objeto que contém informações sobre o crédito concedido. - `diaryIof` number: Valor diário do Imposto sobre Operações Financeiras (IOF). - `fixedIof` number: Valor fixo do Imposto sobre Operações Financeiras (IOF). - `internationalIof` number: Valor internacional do Imposto sobre Operações Financeiras (IOF). - `daysAdvanceCut` integer: Quantidade de dias, a partir do dia de vencimento, até o fechamento da fatura. - `futureCalendarMonths` integer: Número de faturas pré-cadastradas na base de criação da conta. - `daysAccountLockDelay` integer: Quantidade de dias após o atraso no pagamento da fatura em que será realizado o bloqueio do cartão. - `accrualStop` integer: Quantidade de dias, após o atraso no pagamento da fatura, para que o cliente entre em negociação de dívida. - `delayInvoiceRate` number: Valor cobrado pelo atraso do pagamento da fatura (além dos juros). - `rotatingRate` number: Taxa de juros cobrada para faturas não pagas ou pagas parcialmente. - `minimumValueOfRefinanceInstallment` number: Valor mínimo de parcela para faturas que terão o pagamento parcelado. - `invoiceRefinanceRate` number: Valor cobrado pelo parcelamento do pagamento da fatura (além dos juros). - `maximumNumberInstallmentsRefinance` integer: Número máximo de parcelas para pagamento parcelado da fatura. - `annualValue` number: Valor cobrado anualmente para que o cliente tenha o cartão ativo. - `annuityInstallments` integer: Número máximo de parcelas no qual o valor da anuidade pode ser dividido. - `iofFirstDay` boolean: Indica se o cálculo de IOF será feito no primeiro dia do mês (true) ou na data de corte da fatura (false). - `minimumAmountInstallmentAgreementInvoice` number: Valor mínimo referente ao pagamento da fatura após o início da fase de negociação. - `minimumEntryInvoiceAgreement` number: Valor mínimo referente ao pagamento da fatura no início da fase de negociação. - `maximumEntryInvoiceAgreement` number: Valor máximo referente ao pagamento da fatura no início da fase de negociação. - `minimumPercentageInvoiceAgreement` number: Taxa mínima referente ao pagamento da fatura no início da fase de negociação. - `maximumEntryAgreementInvoicePercentage` number: Taxa máxima referente ao pagamento da fatura no início da fase de negociação. - `deadlineInDaysForNewAnalysisRequest` integer: Quantidade de dias em que o cliente pode solicitar uma nova avaliação, após a reprovação do crédito. - `deadlineInDaysForExpirationOfAnalysis` integer: Quantidade de dias em que o cliente pode solicitar uma nova avaliação, após a aprovação do crédito. - `dataHash` string: Termos e condições aceitos pelo cliente. - `acceptanceTermHistory` AcceptanceTerm[]: Lista de objetos contendo informações sobre os termos de aceite e seus detalhes. - `signedAt` string: Data e hora em que o contrato de crédito foi aceito/assinado. - `creditDetails` object: Objeto que contém informações sobre o crédito concedido. - `diaryIof` number: Valor diário do Imposto sobre Operações Financeiras (IOF). - `fixedIof` number: Valor fixo do Imposto sobre Operações Financeiras (IOF). - `internationalIof` number: Valor internacional do Imposto sobre Operações Financeiras (IOF). - `daysAdvanceCut` integer: Quantidade de dias, a partir do dia de vencimento, até o fechamento da fatura. - `futureCalendarMonths` integer: Número de faturas pré-cadastradas na base de criação da conta. - `daysAccountLockDelay` integer: Quantidade de dias após o atraso no pagamento da fatura em que será realizado o bloqueio do cartão. - `accrualStop` integer: Quantidade de dias, após o atraso no pagamento da fatura, para que o cliente entre em negociação de dívida. - `delayInvoiceRate` number: Valor cobrado pelo atraso do pagamento da fatura (além dos juros). - `rotatingRate` number: Taxa de juros cobrada para faturas não pagas ou pagas parcialmente. - `minimumValueOfRefinanceInstallment` number: Valor mínimo de parcela para faturas que terão o pagamento parcelado. - `invoiceRefinanceRate` number: Valor cobrado pelo parcelamento do pagamento da fatura (além dos juros). - `maximumNumberInstallmentsRefinance` integer: Número máximo de parcelas para pagamento parcelado da fatura. - `annualValue` number: Valor cobrado anualmente para que o cliente tenha o cartão ativo. - `annuityInstallments` integer: Número máximo de parcelas no qual o valor da anuidade pode ser dividido. - `iofFirstDay` boolean: Indica se o cálculo de IOF será feito no primeiro dia do mês (true) ou na data de corte da fatura (false). - `minimumAmountInstallmentAgreementInvoice` number: Valor mínimo referente ao pagamento da fatura após o início da fase de negociação. - `minimumEntryInvoiceAgreement` number: Valor mínimo referente ao pagamento da fatura no início da fase de negociação. - `maximumEntryInvoiceAgreement` number: Valor máximo referente ao pagamento da fatura no início da fase de negociação. - `minimumPercentageInvoiceAgreement` number: Taxa mínima referente ao pagamento da fatura no início da fase de negociação. - `maximumEntryAgreementInvoicePercentage` number: Taxa máxima referente ao pagamento da fatura no início da fase de negociação. - `deadlineInDaysForNewAnalysisRequest` integer: Quantidade de dias em que o cliente pode solicitar uma nova avaliação, após a reprovação do crédito. - `deadlineInDaysForExpirationOfAnalysis` integer: Quantidade de dias em que o cliente pode solicitar uma nova avaliação, após a aprovação do crédito. - `dataHash` string: Termos e condições aceitos pelo cliente. ## Other responses - `401` (unresolved $ref) - `500` (unresolved $ref) --- [API](https://skmtc.dev/bankly/apis/gest-o-de-cr-dito.md) - [All operations](https://skmtc.dev/bankly/apis/gest-o-de-cr-dito/llms.txt) - [OpenAPI document](https://skmtc.dev/bankly/apis/gest-o-de-cr-dito/revisions/bc3eab851dee?raw)