v1

latestOpenAPI 3.0.42026-07-24150552428.5 KB

Onboarding

Cadastrar colaboradores (onboarding)

Submete um ou mais colaboradores para abertura de conta BTG. O processamento é assíncrono e retorna 202 Accepted imediatamente.

O campo issuingAuthority aceita apenas os códigos retornados por GET /{companyId}/banking/payroll/onboarding/issuers.

post/{companyId}/banking/payroll/onboarding/employees

Path parameters

companyIdstring required

Headers

X-Idempotency-Keystring uuid required

Chave de idempotência (UUID v4). Evita reprocessamento em caso de retentativa.

Request body

companyTaxIdstring nullable

namestring nullable

taxIdstring nullable

emailstring nullable

phonestring nullable

admissionDatestring nullable

grossMonthlySalarynumber double

accountTypestring nullable

idNumberstring nullable

issuingAuthoritystring nullable

Código do emissor do documento de identidade. Deve ser um dos valores retornados por GET /payroll/issuers. Valores arbitrários são rejeitados com 400.

isUnderageboolean

Response

Accepted

statusstring nullable

All 150 operations