--- title: "Cadastrar devedor" method: POST path: "/laas/v2/debtors" --- # Cadastrar devedor `POST /laas/v2/debtors` ## Request - Base URL: `https://pagamentos.grafeno.be/api/v2` - URL: `https://pagamentos.grafeno.be/api/v2/laas/v2/debtors` - Auth: HTTP basic and API key in header `Authorization` - TypeScript: (a function with typed inputs; its response is checked against the schema) Cadastra o tomador de crédito para as operações. ## Request body - object - `person_type` 'natural_person' | 'legal_person', required: Tipo de tomador de crédito. - `name` string, required: Nome completo do tomador de crédito. - `identification` string, required: CPF ou CNPJ do tomador de crédito. - `email` string, required: E-mail do tomador de crédito. - `phone` string, required: Telefone do tomador de crédito. Formato: (xx) xxxxx-xxxx. - `birth_date` string, date: Data de nascimento do tomador de crédito. Obrigatório para person_type = natural_person. - `marital_status` 'single' | 'married' | 'divorced' | 'widowed': estado civil do tomador de crédito. Obrigatório para person_type = natural_person. - `earnings` number, double: Renda do tomador de crédito. Obrigatório para person_type = natural_person. - `nationality` string: Nacionalidade do tomador de crédito. Obrigatório para person_type = natural_person. - `pep` 'Sim' | 'Não': Indica se o tomador de crédito é ou não uma pessoa politicamente exposta. Obrigatório para person_type = natural_person. - `mother_name` string: Nome da mãe do tomador de crédito. Obrigatório para person_type = natural_person. - `street` string, required: Rua do endereço do tomador de crédito. - `address_number` string, required: Número da residência do tomador de crédito. - `address_complement` string: Complemento do endereço do tomador de crédito. - `neighborhood` string, required: Bairro do endereço do tomador de crédito. - `city` string, required: Cidade do endereço do tomador de crédito. - `state` string, required: Estado do endereço do tomador de crédito. - `zip_code` string, required: CEP do endereço do tomador de crédito. - `country` string: País do endereço do tomador de crédito. - `account_type` 'savings_account' | 'checking_account': Tipo de conta bancária do tomador de crédito. Obrigatório para person_type = natural_person. - `bank` integer: Código do banco do tomador de crédito. Obrigatório para person_type = natural_person. - `bank_agency` string: Agência da conta bancária do tomador de crédito. Obrigatório para person_type = natural_person. - `bank_account_number` string: Número da conta bancária do tomador de crédito com o dígito, ex: 12345-0. Obrigatório para person_type = natural_person. - `foundation_date` string, date: Data de fundação da empresa do tomador de crédito. Obrigatória para person_type = legal person - `legal_status` 'mei' | 'ei' | 'eireli' | 'sociedade_anonima' | 'sociedade_simples_limitada' | 'sociedade_limitada_unipessoal' | 'sociedade_empresaria_limitada' | 'inova_simples' | 'empresario_rural' | 'cooperativa' | 'sociedade_em_conta_de_participacao' | 'empresa_simples_de_credito' | 'sociedade_anonima_do_futebol': Natureza jurídica da empresa do tomador de crédito. Obrigatória para person_type = legal person - `cnae` string: Código CNAE da empresa do tomador de crédito. Obrigatória para person_type = legal person e deve ser informado no seguinte formato: 0000-0/00 - `gross_revenue_last_12_months` number, double: Faturamento bruto do tomador de crédito nos últimos 12 meses. Obrigatório para person_type = legal person - `legal_representatives` object[]: Estrutura para receber os dados dos representantes legais do tomador de crédito quando este for pessoa jurídica. Obrigatório quando o person_type = legal_person. - `name` string, required: Nome do representante legal da empresa tomadora do crédito. - `email` string, required: E-mail do representante legal da empresa tomadora do crédito. - `phone` string, required: Telefone do representante legal da empresa tomadora do crédito. Formato: (xx) xxxxx-xxxx. - `identification` string, required: CPF do representante legal da empresa tomadora do crédito. - `birth_date` string, date, required: Data de nascimento do representante legal da empresa tomadora do crédito. - `mother_name` string, required: Nome da mãe do representante legal da empresa tomadora do crédito. - `pep` 'Sim' | 'Não', required: Indica se o representante legal da empresa tomadora do crédito é ou não uma pessoa politicamente exposta.. - `street` string, required: Rua do endereço do representante legal da empresa tomadora do crédito. - `address_number` string, required: Número da residência do representante legal da empresa tomadora do crédito. - `address_complement` string: Complemento do endereço do representante legal da empresa tomadora do crédito. - `neighborhood` string, required: Bairro do endereço do representante legal da empresa tomadora do crédito. - `city` string, required: Cidade do endereço do representante legal da empresa tomadora do crédito. - `state` string, required: Estado do endereço do representante legal da empresa tomadora do crédito. - `zip_code` string, required: CEP do endereço do representante legal da empresa tomadora do crédito. - `nationality` string: País de origem do representante legal da empresa tomadora do crédito. - `account_type` 'savings_account' | 'checking_account', required: Tipo de conta bancária do representante legal do tomador de crédito. - `bank` integer, required: Código do banco do representante legal do tomador de crédito. - `bank_agency` string, required: Agência da conta bancária do representante legal do tomador de crédito. - `bank_account_number` string, required: Número da conta bancária do representante legal do tomador de crédito. ## Response `201` 201 - object - `debtor_id` string ## Other responses - `400`: 400 --- [API](https://skmtc.dev/grafeno/apis/api-v2-grafeno.md) - [All operations](https://skmtc.dev/grafeno/apis/api-v2-grafeno/llms.txt) - [OpenAPI document](https://skmtc.dev/grafeno/apis/api-v2-grafeno/revisions/20f928f6933f?raw)