Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
Identity verification (KYC) endpoints for natural persons and legal entities: proposals, document upload, CPF validation, and status lookup.
client.kyc resource. See the Method Reference.| Method (SDK) | Description |
|---|---|
naturalProposal | Creates a KYC proposal for a natural person. |
legalProposal | Creates a KYC proposal for a legal entity. |
documentUrl | Gets the URL for document upload. |
check | Looks up the verification status. |
cpfValidate | Validates a CPF (Brazilian taxpayer ID). |
userData | Returns the user data associated with the KYC. |
Bearer <tokenJWT>const proposal = await client.kyc.naturalProposal({ /* natural person data */ });
Bearer <tokenJWT>const proposal = await client.kyc.legalProposal({ /* legal entity data */ });
const { url } = await client.kyc.documentUrl({ /* parameters */ });
const status = await client.kyc.check();
const result = await client.kyc.cpfValidate({ cpf: '000.000.000-00' });
const data = await client.kyc.userData();
403 may indicate pending KYC. Check the limits per verification level on your account.const proposal = await client.kyc.naturalProposal({ /* natural person data */ });