Nesse endpoint você poderá gerenciar suas propostas, incluindo às funcionalidades de consulta e consulta em lote. Acesse https://granapix.com.br/api/docs-swagger/ para obter mais detalhes a respeito dos endpoints básicos.
Consultar
POST/propostas/consultar/
Recebe o número do documento e faz a consulta da proposta.
Headers
Name
Value
Content-Type
application/json
Authorization
Bearer <token>
Body
Name
Type
Description
document_number
string
Número do CPF
Response
{"detail":"Proposta criada com sucesso!","data": {"street":null,"state":null,"city":null,"neighborhood":null,"number":null,"postal_code":null,"complement":null,"unico_base64":null,"unico_encrypted":null,"unico_tipo_doc":null,"unico_doc_frente_base64":null,"unico_doc_frente_encrypted":null,"unico_doc_verso_base64":null,"unico_doc_verso_encrypted":null,"unico_fingerprint":null,"unico_id":null,"unico_score":null,"unico_ocr_code":null,"unico_face_match":null,"unico_status":null,"unico_erro":null,"tipificacao_frente_error_code":null,"tipificacao_frente_error_description":null,"tipificacao_verso_error_code":null,"tipificacao_verso_error_description":null,"name":null,"document_number":"725.558.190-02","birth_date":null,"mother_name":null,"phone":null,"conta_pix":null,"agencia":null,"conta":null,"digito_verificador":null,"tipo_chave_pix":null,"pix":null,"available_balance_key":null,"status_consulta_saldo":null,"motivo_falha_consulta_saldo":null,"total_desejado":null,"valor_maximo":null,"valor_liberado":null,"valor_sem_tac":null,"valor_emissao":null,"issue_amount":null,"iof":null,"tc":null,"taxa_mes":null,"taxa_ano":null,"cet_mes":null,"cet_ano":null,"key":null,"status":null,"status_averbacao":null,"data_consulta_averbacao":null,"detalhes":null,"payload_resposta_qi":null,"ultima_atualizacao":null,"url_contrato":null,"url_contrato_assinado":null,"url_comprovante":null,"data_pagamento":null,"saldo_autoatendimento":null,"error_enumerator":null,"banco":null,"taxa_juros":null,"corban":null,"created_by":null,"modified_by":null }}
{"detail":"Documento inválido! A proposta não foi criada.","document":"725.55f8.190-02"}
Consultar em lote
POST/propostas/consultar_lote/
Recebe vários documentos e faz a consulta das propostas.
Headers
Name
Value
Content-Type
application/json
Authorization
Bearer <token>
Body
Name
Type
Description
documents
string
Documentos com pontos e traços separados por vírgulas
Response
{"detail":"Propostas criadas com sucesso","ids_list": [251,252,253 ]}
{"detail":"Documento inválido! Nenhuma das propostas foi criada.","document":"725.55f8.190-02"}
