--- openapi: 3.0.0 info: title: ZenBank API version: 1.0.0 description: > Manual de Utilização da API ZenBank. Está API permite a integração com o produto FGTS. contact: name: Suporte ZenBank email: contato@zenbank.digital license: name: MIT url: https://opensource.org/licenses/MIT servers: - url: https://api.zenbank.digital description: Servidor de Produção - url: https://api-qa.zenbank.digital description: Servidor de Sandbox paths: /v1/anti-fraud/refusal: get: summary: Verificação Anti-Fraude parameters: - name: document in: query required: true schema: type: string example: "13956950917" responses: "200": description: OK content: application/json: schema: type: object properties: meta: type: object properties: datetime: type: string example: "2024-05-20 19:20:25" data: type: object properties: success: type: boolean example: true message: type: string example: "No data found" "400": description: Bad Request "401": description: Unauthorized "403": description: Forbidden "404": description: Not Found "500": description: Internal Server Error /v1/bankerize/fgts/balance: get: summary: Consulta de Saldo parameters: - name: document in: query required: true schema: type: string example: "139.569.509-17" - name: wish_amount in: query required: true schema: type: number format: float example: 183.33 responses: "200": description: OK content: application/json: schema: type: object properties: data: type: object properties: installments: type: object net_value: type: number example: 45335 gross_value: type: number example: 105653.84 monthly_cet: type: number example: 1.89389 annual_cet: type: number example: 25.24994 monthly_fee: type: number example: 1.79 annual_interest: type: number example: 23.72611 tc_value: type: number example: 0 iof_value: type: number example: 1228.66 interest_value: type: number example: 58614.1 simulation_id: type: string nullable: true message: type: string example: "Parcelas encontradas com sucesso!" "400": description: Bad Request "401": description: Unauthorized "403": description: Forbidden "404": description: Not Found "500": description: Internal Server Error /v1/bankerize/proposal/cancel: post: summary: Cancelamento de Proposta requestBody: required: true content: application/json: schema: type: object properties: proposal_id: type: integer example: 186837576 external_proposal_id: type: integer example: 132 creditor_bank: type: integer example: 1234 responses: "200": description: OK content: application/json: schema: type: object properties: meta: type: object properties: datetime: type: string example: "2024-05-20 19:28:07" data: type: object properties: message: type: string example: "Proposta cancelada com sucesso!" "400": description: Bad Request "401": description: Unauthorized "403": description: Forbidden "404": description: Not Found "500": description: Internal Server Error /v1/ccb-status: get: summary: Consultar Dados da CCB parameters: - name: external_proposal_id in: query required: true schema: type: integer example: 132 responses: "200": description: OK content: application/json: schema: type: object properties: meta: type: object properties: datetime: type: string example: "2024-05-20 19:24:28" data: type: object properties: status: type: string example: "Aguardando Pagamento" external_proposal_id: type: integer example: 132 "400": description: Bad Request "401": description: Unauthorized "403": description: Forbidden "404": description: Not Found "500": description: Internal Server Error /v1/clients/account: post: summary: Criação de Conta requestBody: required: true content: application/json: schema: type: object properties: birthdate: type: string format: date example: "2000-04-01" document: type: string example: "139.569.509-17" email: type: string example: "falecom@zenbank.digital" gender: type: string example: "Feminino" name: type: string example: "Aline Luiza" phone: type: string example: "(11) 98756-2312" responses: "200": description: OK content: application/json: schema: type: object properties: meta: type: object properties: datetime: type: string example: "2024-05-20 19:21:37" data: type: object properties: id: type: integer example: 2825894 name: type: string example: "Aline Luiza" email: type: string example: "falecom@zenbank.digital" document: type: string example: "139.569.509-17" birthdate: type: string example: "2000-04-01" phone: type: string example: "(11) 98756-2312" gender: type: string example: "Feminino" responsible_id: type: integer example: 726872 user_id: type: integer example: 2782912 tenant_id: type: integer example: 1 token: type: string example: "$2y$10$M9K4zGyZjB8444H5FNbfeTrkBGfMs0MyKgUxhcWI0MjUI41Noq" obs: type: string nullable: true updated_at: type: string example: "2024-05-20T22:21:37.000000Z" created_at: type: string example: "2024-05-20T22:21:37.000000Z" "400": description: Bad Request "401": description: Unauthorized "403": description: Forbidden "404": description: Not Found "500": description: Internal Server Error /v1/clients/address: post: summary: Criação de Endereço requestBody: required: true content: application/json: schema: type: object properties: zipcode: type: string example: "12903-834" street: type: string example: "Rua sete" number: type: string example: "111" unit: type: string nullable: true example: "" neighborhood: type: string example: "Salvador" state: type: string example: "BA" city: type: string example: "SALVADOR" account_id: type: integer example: 2825894 responses: "200": description: OK content: application/json: schema: type: object properties: meta: type: object properties: datetime: type: string example: "2024-05-20 19:24:02" data: type: object properties: id: type: integer example: 2571107 zipcode: type: string example: "12903-834" street: type: string example: "Rua sete" number: type: string example: "111" unit: type: string nullable: true neighborhood: type: string example: "Salvador" city: type: string example: "SALVADOR" state: type: string example: "BA" account_id: type: integer example: 2825894 updated_at: type: string example: "2024-05-20T22:24:02.000000Z" created_at: type: string example: "2024-05-20T22:24:02.000000Z" "400": description: Bad Request "401": description: Unauthorized "403": description: Forbidden "404": description: Not Found "500": description: Internal Server Error /v1/clients/bank-account: post: summary: Criação de Conta Bancária requestBody: required: true content: application/json: schema: type: object properties: bank_id: type: integer example: 3 account_type: type: string example: "CORRENTE" branch_number: type: string example: "145" account_number: type: string example: "7652412" input_type: type: string example: "manual" account_id: type: integer example: 2825894 pix_key: type: string example: "231231231232" required: - pix_key responses: "200": description: OK content: application/json: schema: type: object properties: meta: type: object properties: datetime: type: string example: "2024-05-20 19:24:28" data: type: object properties: account_id: type: integer example: 2825894 account_type: type: string example: "CORRENTE" branch_number: type: string example: "145" account_number: type: string example: "7652412" bank_id: type: integer example: 3 pix_key: type: string example: "23131231212" account_created_at: type: string example: null updated_at: type: string format: date-time example: "2024-05-20T22:24:28.000000Z" created_at: type: string format: date-time example: "2024-05-20T22:24:28.000000Z" id: type: integer example: 2361255 "400": description: Bad Request "401": description: Unauthorized "403": description: Forbidden "404": description: Not Found "500": description: Internal Server Error /v1/clients/qualification: post: summary: Criação de Qualificação requestBody: required: true content: application/json: schema: type: object properties: document_type: type: string example: "RG" document_number: type: string example: "3278812342" document_issued_at: type: string format: date example: "2015-08-12" document_state: type: string example: "BA" marital_status: type: string example: "Solteiro(a)" mother_name: type: string example: "Marilia Santos" account_id: type: integer example: 2825894 document_issued_by: type: string example: "SSP" responses: "200": description: OK content: application/json: schema: type: object properties: meta: type: object properties: datetime: type: string example: "2024-05-20 19:22:45" data: type: object properties: id: type: integer example: 2609192 document_type: type: string example: "RG" document_number: type: string example: "3278812342" document_state: type: string example: "BA" document_issued_at: type: string example: "2015-08-12" marital_status: type: string example: "Solteiro(a)" mother_name: type: string example: "Marilia Santos" account_id: type: integer example: 2825894 updated_at: type: string example: "2024-05-20T22:22:45.000000Z" created_at: type: string example: "2024-05-20T22:22:45.000000Z" "400": description: Bad Request "401": description: Unauthorized "403": description: Forbidden "404": description: Not Found "500": description: Internal Server Error /v1/payments/banks: get: summary: Consulta de Bancos responses: "200": description: OK content: application/json: schema: type: object properties: meta: type: object properties: datetime: type: string example: "2024-05-20 19:24:02" data: type: array items: type: object "400": description: Bad Request "401": description: Unauthorized "403": description: Forbidden "404": description: Not Found "500": description: Internal Server Error /v1/proposals/debit: post: summary: Criação de Proposta requestBody: required: true content: application/json: schema: type: object properties: account_id: type: integer example: 2825894 responses: "200": description: OK content: application/json: schema: type: object properties: meta: type: object properties: datetime: type: string example: "2024-05-20 19:28:07" data: type: object properties: id: type: integer example: 186837576 token: type: string example: "$2y$10$M9K4zGyZjB8444H5FNbfeTrkBGfMs0MyKgUxhcWI0MjUI41Noq" "400": description: Bad Request "401": description: Unauthorized "403": description: Forbidden "404": description: Not Found "500": description: Internal Server Error /v1/proposals: get: summary: Listar todas as propostas parameters: - name: begin_date in: query required: false schema: type: string example: "01/10/2024" - name: end_date in: query required: false schema: type: string example: "03/10/2024" - name: document in: query required: false schema: type: string example: "410.851.788-11" - name: name in: query required: false schema: type: string example: Aline Santos Batista de Sousa - name: page in: query required: false schema: type: integer example: 2 - name: limit in: query required: false schema: type: integer example: 20 - name: proposal_id in: query required: false schema: type: integer example: 321312312 - name: external_proposal_id in: query required: false schema: type: integer example: 123231232 - name: status in: query required: false schema: type: string example: "Falta autorização" - name: supplier_id in: query required: false schema: type: integer example: 4 - name: issue_type in: query required: false schema: type: string example: "Financeiro" - name: external_proposal_id_not_null in: query required: false schema: type: boolean example: true - name: antifraud_completed in: query required: false schema: type: boolean example: true - name: promoter_id in: query required: false schema: type: integer example: 71 - name: product_id in: query required: true schema: type: integer example: 3 responses: "200": description: OK content: application/json: schema: type: object properties: meta: type: object properties: datetime: type: string example: "2024-10-08 02:12:33" data: type: object properties: current_page: type: integer example: 1 data: type: array items: type: object properties: account_id: type: integer example: 3723949 proposal_id: type: integer example: 187855626 simulation: type: string example: '{"cet": 0.0245, "tac": 133.24, "periods": [{...}]}' created_at: type: string example: "08/10/2024 02:05" document: type: string example: "491.570.908-66" token: type: string example: "$2y$10$VJZEp1LqekHgPcY3OOFn5TUbOposQnqtIOnuXITgcKO1X8vxlka" name: type: string example: "Aline" full_name: type: string example: "Aline Santos Batista de Sousa" birthdate: type: string example: "1999-09-10" status: type: string example: "Cancelada" amount: type: string example: "1149.34" net_amount: type: string example: "978.29" product_name: type: string example: "FGTS" rate_name: type: string example: "Zen - TX 1,70 am" creditor_bank: type: string example: "ANGA" external_proposal_id: type: string example: "d368b72b-5e3e-4975-81e8-9ef47eec754c" bank_account_id: type: integer example: 3166243 email: type: string example: "falecom@zenbank.digital" supplier_name: type: string example: "QITECH" "400": description: Bad Request "401": description: Unauthorized "403": description: Forbidden "404": description: Not Found "500": description: Internal Server Error /v1/antecipate-fgts/simulation: get: summary: Detalhe da proposta de antecipação FGTS parameters: - name: account_id in: query required: true schema: type: integer example: 3379246 responses: "200": description: OK content: application/json: schema: type: object properties: meta: type: object properties: datetime: type: string example: "2024-10-08 02:15:28" data: type: object properties: cet: type: number example: 0.0197 tac: type: number example: 0 periods: type: array items: type: object properties: due_date: type: string example: "2025-10-01" workdays: type: integer example: 246 tax_amount: type: number example: 1.171401530250041 has_interest: type: boolean example: true total_amount: type: number example: 63.24 calendar_days: type: integer example: 358 due_principal: type: number example: 99.88 pre_fixed_amount: type: number example: 23.3366912982 business_due_date: type: string example: "2025-10-01" post_fixed_amount: type: string nullable: true installment_number: type: integer example: 1 principal_amortization_amount: type: number example: 39.9033087018 rate_id: type: integer example: 17 annual_cet: type: number example: 0.264037 iof_amount: type: number example: 3.35 annual_rate: type: number example: 0.2387205315755283 supplier_id: type: integer example: 1 tc_eligible: type: boolean example: true issue_amount: type: number example: 99.88 monthly_rate: type: number example: 0.018 insurance_amount: type: number example: 0 assignment_amount: type: number example: 99.88 periods_total_amount: type: number example: 146.24 disbursed_issue_amount: type: number example: 96.53 "400": description: Bad Request "401": description: Unauthorized "403": description: Forbidden "404": description: Not Found "500": description: Internal Server Error /v1/proposals/{id}/history: get: summary: Histórico da proposta parameters: - name: id in: path required: true schema: type: integer example: 187855623 responses: "200": description: OK content: application/json: schema: type: object properties: meta: type: object properties: datetime: type: string example: "2024-10-08 02:16:06" data: type: array items: type: object properties: ph_id: type: integer example: 7755489 responsible: type: string nullable: true example: "Franciele Aparecida Mendes Lima" action: type: string example: "Proposta paga." created_at: type: string example: "08/10/2024 02:05:01" ts_created_at: type: integer example: 1728353101 "400": description: Bad Request "401": description: Unauthorized "403": description: Forbidden "404": description: Not Found "500": description: Internal Server Error /v1/anti-fraud: get: summary: Antifraude da proposta parameters: - name: account_id in: query required: true schema: type: integer example: 3723895 - name: proposal_id in: query required: true schema: type: integer example: 187855622 responses: "200": description: OK content: application/json: schema: type: object properties: meta: type: object properties: datetime: type: string example: "2024-10-08 02:17:04" data: type: object properties: account_id: type: integer example: 3379246 name: type: string example: "Franciele Aparecida Mendes Lima" birthdate: type: string example: "12/10/1993" document: type: string example: "071.676.719-83" phone: type: string example: "(44) 99708-7972" email: type: string example: "falecom@zenbank.digital" token: type: string example: "$2y$10$rpDfjhbQ3QFPa8afC5vJRRMuaKZwXaCYB9SXt1OTY0b2CVi8RBKO" tenant_id: type: integer example: 1 master_id: type: integer example: 1 promoter_id: type: integer example: 1040 responsible_id: type: integer example: 1629271 proposal_id: type: integer example: 187855625 status: type: string example: "Paga" amount: type: string example: "99.88" product_id: type: integer example: 3 supplier_id: type: integer example: 1 creditor_bank: type: string example: "ANGA" history: type: array items: type: object properties: id: type: integer example: 20684235 account_id: type: integer example: 3379246 proposal_id: type: integer nullable: true example: 187855623 description: type: string example: "Cliente enviou a Selfie" created_at: type: string example: "2024-10-08T04:54:31.000000Z" location: type: object properties: latitude: type: number example: -23.5243922 longitude: type: number example: -51.6596338 accuracy: type: number example: 100 altitude: type: number example: 741.7999877929688 deviceinfo: type: string example: '{"browser":{"name":"Chrome","version":"129.0.0.0"},"engine":{"name":"Blink","version":"129.0.0.0"},"os":{"name":"Android","version":"10"},"device":{"model":"K","type":"mobile"},"cpu":[],"ip":"177.155.95.181"}' details: type: object properties: receita: type: object properties: name: type: string example: "FRANCIELE APARECIDA MENDES LIMA" birthdate: type: string example: "12/10/1993" base_status: type: string example: "Regular" unico: type: object properties: score: type: integer example: 95 score_description: type: string example: "Temos evidências suficientes de que o cadastro é do real dono do CPF" liveness: type: integer example: 1 liveness_description: type: string example: "Foto ao vivo" status: type: integer example: 3 status_description: type: string example: "Concluído" "400": description: Bad Request "401": description: Unauthorized "403": description: Forbidden "404": description: Not Found "500": description: Internal Server Error /v1/anti-fraud/document-verification: post: summary: Adicionar Documento requestBody: required: true content: application/json: schema: type: object properties: type: type: string example: "RG" side: type: string example: "A" encrypted: type: boolean example: false account_id: type: integer example: 11 document: type: string example: "01400708346" img: type: string example: "data:image/jpeg;base64,/..." admin: type: string example: "Jane Smith" client: type: string example: "John Doe" process_id: type: integer example: 123 required: - type - side - encrypted - account_id - document - img responses: "200": description: OK content: application/json: schema: type: object properties: meta: type: object properties: datetime: type: string example: "2024-10-31 17:59:20" data: type: object properties: id: type: integer example: 9 proposal_id: type: integer nullable: true account_id: type: integer example: 6 url_document_1: type: string example: "https://zen-dev-public.s3.amazonaws.com/antifraud/WJZqMx9rFbqouL7document_1.jpg" uuid_document_1: type: string example: "4dd715e0-a776-4504-81e4-fe6e27c85feb" type_document_1: type: string example: "RG_A" url_document_2: type: string example: "https://zen-dev-public.s3.amazonaws.com/antifraud/S1CtTql5qF5Y1DIdocument_2.jpg" uuid_document_2: type: string example: "05cfdb6d-4a8e-4baf-96ff-ab185606af1d" url_selfie: type: string example: "https://zen-dev-public.s3.amazonaws.com/antifraud/L02eAxfB1C0RgFY_selfie.jpg" uuid_selfie: type: string example: "d503de7f-f2d9-4443-88e2-a7a2f20490e1" location: type: string nullable: true deviceinfo: type: string nullable: true details: type: string example: '{"receita":[],"process_id":"testID"}' approved: type: string nullable: true approver_id: type: string nullable: true created_at: type: string example: "2024-10-31T13:14:46.000000Z" updated_at: type: string nullable: true unico_process_id: type: string example: "testID" /v1/anti-fraud/selfie: post: summary: Adicionar Selfie requestBody: required: true content: application/json: schema: type: object properties: encrypted: type: boolean example: false account_id: type: integer example: 11 document: type: string example: "01400708346" img: type: string example: "data:image/jpeg;base64,/..." client: type: string example: "John Doe" name: type: string example: "My Device" location: type: string example: "SP" latitude: type: number example: 40.712776 longitude: type: number example: -74.005974 accuracy: type: integer example: 5 altitude: type: number example: 15.3 altitudeAccuracy: type: number example: 1.2 heading: type: integer example: 90 speed: type: number example: 1.5 browser: type: string example: "Chrome" engine: type: string example: "Blink" os: type: string example: "Android" version: type: string example: "11" device: type: string example: "mobile" model: type: string example: "SM-G991B" type: type: string example: "smartphone" vendor: type: string example: "Samsung" cpu: type: string example: "Exynos 2100" architecture: type: string example: "ARM" required: - encrypted - account_id - document - img responses: "200": description: OK content: application/json: schema: type: object properties: meta: type: object properties: datetime: type: string example: "2024-11-01 13:59:58" data: type: object properties: process_id: type: string example: "testID" skip_documents: type: integer example: 0 put: summary: Atualizar Selfie requestBody: required: true content: application/json: schema: type: object properties: encrypted: type: boolean example: false account_id: type: integer example: 11 document: type: string example: "01400708346" img: type: string example: "data:image/jpeg;base64,/..." responses: "200": description: OK content: application/json: schema: type: object properties: meta: type: object properties: datetime: type: string example: "2024-11-05 10:04:46" data: type: object properties: id: type: integer example: 14 proposal_id: type: integer nullable: true account_id: type: integer example: 11 url_document_1: type: string example: "https://zen-dev-public.s3.amazonaws.com/antifraud/r4YwW8eBowrtGhx_document_1.jpg" uuid_document_1: type: string example: "4d05cf87-0ada-4b91-b382-228d3cfb581b" url_document_2: type: string example: "https://zen-dev-public.s3.amazonaws.com/antifraud/EHX61jhRQJf0CtMdocument_2.jpg" uuid_document_2: type: string example: "9f81d848-60a9-4894-96fb-221a2e3318ac" url_selfie: type: string example: "https://zen-dev-public.s3.amazonaws.com/antifraud/EOHjsu49FPF6j0y_selfie.jpg" uuid_selfie: type: string example: "3be90f34-eb4c-453c-9046-85aa87978d08" location: type: string nullable: true deviceinfo: type: string nullable: true details: type: string example: '{"receita":null,"process_id":"testID"}' approved: type: string nullable: true approver_id: type: string nullable: true created_at: type: string example: "2024-11-01T16:59:58.000000Z" updated_at: type: string nullable: true unico_process_id: type: string example: "testID" /v1/anti-fraud/document: put: summary: Atualizar Documento requestBody: required: true content: application/json: schema: type: object properties: type: type: string example: "RG" side: type: string example: "A" encrypted: type: boolean example: false account_id: type: integer example: 11 document: type: string example: "01400708346" img: type: string example: "data:image/jpeg;base64,/..." responses: "200": description: OK content: application/json: schema: type: object properties: meta: type: object properties: datetime: type: string example: "2024-11-05 07:08:38" data: type: object properties: id: type: integer example: 14 proposal_id: type: integer nullable: true account_id: type: integer example: 11 url_document_1: type: string example: "https://zen-dev-public.s3.amazonaws.com/antifraud/r4YwW8eBowrtGhx_document_1.jpg" uuid_document_1: type: string example: "4d05cf87-0ada-4b91-b382-228d3cfb581b" url_document_2: type: string example: "https://zen-dev-public.s3.amazonaws.com/antifraud/EHX61jhRQJf0CtMdocument_2.jpg" uuid_document_2: type: string example: "9f81d848-60a9-4894-96fb-221a2e3318ac" url_selfie: type: string example: "https://zen-dev-public.s3.amazonaws.com/antifraud/IyHFwr39f5CgQD9_selfie.jpg" uuid_selfie: type: string example: "3be90f34-eb4c-453c-9046-85aa87978d08" location: type: string nullable: true deviceinfo: type: string nullable: true details: type: string example: '{"receita":[],"process_id":"testID"}' approved: type: string nullable: true approver_id: type: string nullable: true created_at: type: string example: "2024-11-01T16:59:58.000000Z" updated_at: type: string nullable: true unico_process_id: type: string example: "testID" /v1/clients/{id}: get: summary: Detalhe do cliente (Dados Cadastrais) parameters: - name: id in: path required: true schema: type: integer example: 3723895 - name: proposal_id in: query required: true schema: type: integer example: 187855622 responses: "200": description: OK content: application/json: schema: type: object properties: meta: type: object properties: datetime: type: string example: "2024-10-08 02:18:31" data: type: object properties: id: type: integer example: 3379246 name: type: string example: "Franciele Aparecida Mendes Lima" email: type: string example: "falecom@zenbank.digital" document: type: string example: "071.676.719-83" birthdate: type: string example: "1993-10-12" phone: type: string example: "(44) 99708-7972" gender: type: string example: "Feminino" user_id: type: integer example: 3336270 tenant_id: type: integer example: 1 master_id: type: integer example: 1 promoter_id: type: integer example: 1040 token: type: string example: "$2y$10$rpDfjhbQ3QFPa8afC5vJRRMuaKZwXaCYB9SXt1OTY0b2CVi8RBKO" responsible_id: type: integer example: 1629271 seller: type: string nullable: true created_at: type: string example: "2024-08-10 03:04:11" updated_at: type: string example: "2024-08-10 03:04:11" promoter_name: type: string example: "14122 - RAFAELA SANTANA BISPO" user_active: type: integer example: 1 user_tenant_id: type: integer example: 1 bank_account_id: type: integer example: 2852974 proposal_id: type: integer example: 187855625 "400": description: Bad Request "401": description: Unauthorized "403": description: Forbidden "404": description: Not Found "500": description: Internal Server Error /v1/clients/{account_id}/qualification/{qualification_id}: get: summary: Detalhe dos Documentos do cliente parameters: - name: account_id in: path required: true schema: type: integer example: 3379246 - name: qualification_id in: path required: true schema: type: integer example: 3125556 responses: "200": description: OK content: application/json: schema: type: object properties: meta: type: object properties: datetime: type: string example: "2024-10-08 02:19:11" data: type: object properties: id: type: integer example: 3125556 document_type: type: string example: "RG" document_number: type: string example: "124290937" document_state: type: string example: "PR" document_issued_at: type: string example: "2008-02-19" document_issued_by: type: string nullable: true marital_status: type: string example: "Solteiro(a)" mother_name: type: string example: "Rosilene Luzia Mendes" account_id: type: integer example: 3379246 created_at: type: string example: "2024-08-10 03:11:24" updated_at: type: string example: "2024-08-10 03:11:24" master_id: type: integer example: 1 "400": description: Bad Request "401": description: Unauthorized "403": description: Forbidden "404": description: Not Found "500": description: Internal Server Error /v1/clients/{account_id}/address/{address_id}: get: summary: Detalhe do Endereço do cliente parameters: - name: account_id in: path required: true schema: type: integer example: 3379246 - name: address_id in: path required: true schema: type: integer example: 3081014 responses: "200": description: OK content: application/json: schema: type: object properties: meta: type: object properties: datetime: type: string example: "2024-10-08 02:19:28" data: type: object properties: id: type: integer example: 3081014 zipcode: type: string example: "86975-000" street: type: string example: "Rua Pedro bergamasco" unit: type: string nullable: true number: type: integer example: 33 neighborhood: type: string example: "Boa vista" city: type: string example: "MANDAGUARI" state: type: string example: "PR" country: type: string example: "Brasil" account_id: type: integer example: 3379246 created_at: type: string example: "2024-08-10 03:11:52" updated_at: type: string example: "2024-08-10 03:11:52" responsible_id: type: integer example: 1629271 tenant_id: type: integer example: 1 master_id: type: integer example: 1 promoter_id: type: integer example: 1040 "400": description: Bad Request "401": description: Unauthorized "403": description: Forbidden "404": description: Not Found "500": description: Internal Server Error /v1/clients/{account_id}/bank-account/{bank_account_id}: get: summary: Detalhe da Conta Bancária do cliente parameters: - name: account_id in: path required: true schema: type: integer example: 3379246 - name: bank_account_id in: path required: true schema: type: integer example: 2852974 responses: "200": description: OK content: application/json: schema: type: object properties: meta: type: object properties: datetime: type: string example: "2024-10-08 02:19:51" data: type: object properties: id: type: integer example: 2852974 pix_key: type: string nullable: true account_type: type: string example: "CORRENTE" branch_number: type: string example: "0001" account_number: type: string example: "202478838" account_created_at: type: string nullable: true bank_id: type: integer example: 308 account_id: type: integer example: 3379246 created_at: type: string example: "2024-08-10 03:12:59" updated_at: type: string example: "2024-08-10 03:12:59" responsible_id: type: integer example: 1629271 tenant_id: type: integer example: 1 master_id: type: integer example: 1 promoter_id: type: integer example: 1040 "400": description: Bad Request "401": description: Unauthorized "403": description: Forbidden "404": description: Not Found "500": description: Internal Server Error /v1/proposals/{id}/details: get: summary: Detalhe da proposta parameters: - name: id in: path required: true schema: type: integer example: 187855623 responses: "200": description: OK content: application/json: schema: type: object properties: meta: type: object properties: datetime: type: string example: "2024-10-08 02:20:06" data: type: object properties: created_at: type: string example: "08/10 02:00" account_id: type: integer example: 3379246 name: type: string example: "Franciele Aparecida Mendes Lima" document: type: string example: "071.676.719-83" ddd: type: string example: "44" phone: type: string example: "99708-7972" state: type: string example: "PR" wish_amount: type: string example: "96.53" responsible_id: type: integer example: 1629271 tenant_id: type: integer example: 1 master_id: type: integer example: 1 promoter_id: type: integer example: 1040 responsible_name: type: string example: "Franciele aparecida Lider Isabella" status: type: string example: "Paga" payment_transaction_id: type: string nullable: true constituted_margin: type: integer example: 1 creditor_bank: type: string example: "ANGA" amount: type: string example: "99.88" external_proposal_id: type: string example: "dee73ea3-65ed-4fb5-b084-fc2c1f8d11ca" external_proposal_number: type: string example: "0085764545/FAM" warranty_id: type: string example: "48bc456f-f3e2-4874-bedf-c6471586fc24" product_id: type: integer example: 3 quota_qty: type: integer example: 4 tax: type: string example: "1.80" iof: type: string example: "3.35" tac: type: string example: "0.50" cet: type: string example: "1.97" rate_name: type: string example: "Zen - TX 1,79 am" document_type: type: string example: "RG" document_number: type: string example: "124290937" document_issued_by: type: string nullable: true document_issued_at: type: string example: "19/02/2008" document_state: type: string example: "PR" gender: type: string example: "Feminino" birthdate: type: string example: "12/10/1993" marital_status: type: string example: "Solteiro(a)" mother_name: type: string example: "Rosilene luzia Mendes" email: type: string example: "falecom@zenbank.digital" zipcode: type: string example: "86975-000" street: type: string example: "Rua Pedro bergamasco" number: type: integer example: 33 unit: type: string nullable: true neighborhood: type: string example: "Boa vista" city: type: string example: "MANDAGUARI" bank: type: string example: "Nubank" bank_code: type: string example: "260" account_type: type: string example: "CORRENTE" branch_number: type: string example: "0001" account_number: type: string example: "202478838" account_created_at: type: string nullable: true "400": description: Bad Request "401": description: Unauthorized "403": description: Forbidden "404": description: Not Found "500": description: Internal Server Error components: schemas: Error: type: object properties: code: type: integer example: 400 message: type: string example: "Invalid request" /v1/anti-fraud: get: summary: Detalhe da proposta params: account_id: "255" client: "0" response: account_id: 255 name: "Iago dos Santos Almeida" birthdate: "01/07/2001" document: "014.017.544-06" token: "$2y$10$lMd7oBvnZCBTAPNl7mxObOb8tNGMx7ncqn0RtI8lhmzeweF5TV9a" tenant_id: 1 promoter_id: 1 responsible_id: 5 id: 9 proposal_id: 22 uuid_document_1: "1c0d0bc5-4af9-43a9-a3f6-a7de0c103eb2" type_document_1: "RG_A" uuid_document_2: "18a97d95-7f0c-4bcf-a46f-f20619de7e38" type_document_2: "RG_B" uuid_selfie: "66de7e94-fdbc-45c9-b391-080e5e69b5bf" location: latitude: -29.6918333 longitude: -53.838955 accuracy: 100 altitude: 87.0999984741211 altitudeAccuracy: null heading: null speed: null deviceinfo: '{"browser":{"name":"Chrome","version":"124.0.0.0"},"engine":{"name":"Blink","version":"124.0.0.0"},"os":{"name":"Android","version":"10"},"device":{"model":"K","type":"mobile"},"cpu":[]}' details: receita: name: "LUANA ANDERSON DE ALMEIDA" birthdate: "07/12/1994" base_status: "Regular" process_id: "abc836e8-5a0a-4c39-aac9-db3f66ab1874" unico: score: 70 score_description: "Temos evidências suficientes de que o cadastro é do real dono do CPF" liveness: 1 liveness_description: "Foto ao vivo" status: 3 status_description: "Concluído" facematch: 1 hasbiometry: true ocrcode: 1 document_sent_by_admin: 0 ocr_document: null facematch: null approved: null approver_id: null created_at: "2024-11-12 19:14:43" updated_at: "2024-11-12 19:14:43" unico_process_id: "abc836e8-5a0a-4c39-aac9-db3f66ab1874" file_document_1: "https://zen-dev-public.s3.us-east-1.amazonaws.com/antifraud/r4YwW8eBowrtGhx_document_1.jpg" file_document_2: "https://zen-dev-public.s3.us-east-1.amazonaws.com/antifraud/r4YwW8eBowrtGhx_document_1.jpg" file_selfie: "https://zen-dev-public.s3.us-east-1.amazonaws.com/antifraud/WYidIU5ac0lHdz7_selfie.jpg" history: error: message: "Infelizmente não foi possível encontrar este registro." status: 404 errors: []