APIPartes
Criar parte
Authorization
apiKey X-API-Key<token>
Chave de API (prefixo nbr_) ou Token de Acesso Pessoal (prefixo pat_)
In: header
Header Parameters
Idempotency-Key?string
Chave de idempotência para evitar processamento duplicado. Use um UUID v4 único por requisição.
Format
uuidRequest Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Dados para criação de uma parte.
Para pessoa física (type: "person"), informe full_name, birth_date e CPF em document_number.
Para pessoa jurídica (type: "company"), informe company_name e CNPJ em document_number.
O campo email é obrigatório para ambos os tipos.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/parties" \ -H "Content-Type: application/json" \ -d '{ "type": "person", "document_number": "52998224725", "email": "user@example.com", "address": { "cep": "89201100", "street": "Rua XV de Novembro", "number": "1234" } }'{ "id": "pty_abc123", "type": "person", "document_number": "string", "email": "string", "phone": "string", "full_name": "string", "nationality": "string", "profession": "string", "marital_status": "string", "marriage_regime": "string", "prenuptial_agreement": {}, "birthdate": "2019-08-24T14:15:22Z", "company_name": "string", "cep": "string", "street": "string", "number": "string", "complement": "string", "district": "string", "city": "string", "state": "string", "tenant_id": "string", "organization_id": "string", "visibility": "restricted", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "created_by": "string", "updated_by": "string"}{ "type": "validation", "title": "Validation Failed", "status": 400, "detail": "name is required", "code": "validation.required", "instance": "/public/v1/brokers", "request_id": "req_abc123", "timestamp": "2026-02-15T12:00:00Z", "documentation_url": "https://docs.nobur.com.br/errors/validation", "errors": [ { "field": "name", "message": "name is required", "code": "validation.broker.name_required" } ]}{ "type": "unauthorized", "title": "Authentication Required", "status": 401, "detail": "authentication required", "code": "unauthorized.auth_required", "request_id": "req_abc123", "timestamp": "2026-02-15T12:00:00Z", "documentation_url": "https://docs.nobur.com.br/errors/unauthorized"}{ "type": "forbidden", "title": "Access Denied", "status": 403, "detail": "insufficient permissions", "code": "forbidden.insufficient_permissions", "request_id": "req_abc123", "timestamp": "2026-02-15T12:00:00Z", "documentation_url": "https://docs.nobur.com.br/errors/forbidden"}{ "type": "conflict", "title": "Resource Conflict", "status": 409, "detail": "broker with this CRECI already exists", "code": "conflict.duplicate", "request_id": "req_abc123", "timestamp": "2026-02-15T12:00:00Z", "documentation_url": "https://docs.nobur.com.br/errors/conflict"}{ "type": "rate_limit", "title": "Rate Limit Exceeded", "status": 429, "detail": "rate limit exceeded", "code": "rate_limit.exceeded", "retry_after": 60, "request_id": "req_abc123", "timestamp": "2026-02-15T12:00:00Z", "documentation_url": "https://docs.nobur.com.br/errors/rate-limit"}{ "type": "internal", "title": "Internal Server Error", "status": 500, "detail": "an unexpected error occurred", "code": "internal.unexpected", "request_id": "req_abc123", "timestamp": "2026-02-15T12:00:00Z", "documentation_url": "https://docs.nobur.com.br/errors/internal"}