Métodos do SDK

Esta página documenta todos os métodos públicos disponíveis na instância do PixFace SDK.

`mount`

Inicializa e monta o SDK no DOM. Este método deve ser chamado após a criação da instância do SDK e antes de qualquer outra operação.

Type: Function Returns: Promise<void>

const sdk = PixFace({
  apiURL: "https://api.dev.pixtopay.com",
  api_key: "pk_dev_xxxxxxxxx",
  integrationId: "sua-integration-id"
});
 
sdk.mount().then(() => {
  console.log("SDK montado com sucesso!");
});

`verifyDocument`

Inicia o fluxo padrão.

Type: Function Parameters: Object Returns: Promise<void>

sdk.verifyDocument({
  cpf: "12345678900", 
  referenceId: "order-123",
  action: "signup"
});

Parâmetros:

Nome	Tipo	Descrição	Obrigatório
`cpf`	`string`	CPF do usuário (apenas números ou formatado)	✅ Sim
`referenceId`	`string`	ID de referência para rastreamento	❌ Não
`action`	`string`	Nome da ação sendo executada	❌ Não

`startFaceIndex`

Inicia o fluxo de Liveness.

Type: Function Parameters: Object Returns: Promise<void>

sdk.startFaceIndex({
  cpf: "12345678900",
  referenceId: "user-456"
});

Parâmetros:

Nome	Tipo	Descrição	Obrigatório
`cpf`	`string`	CPF do usuário (apenas números ou formatado)	✅ Sim
`referenceId`	`string`	ID de referência para rastreamento	❌ Não

`openVerifySOWFlow`

Inicia o fluxo Source of Wealth (Origem dos Recursos).

Type: Function Parameters: Object Returns: Promise<void>

sdk.openVerifySOWFlow({
  cpf: "12345678900",
  referenceId: "transaction-789"
});

Parâmetros:

Nome	Tipo	Descrição	Obrigatório
`cpf`	`string`	CPF do usuário (apenas números ou formatado)	✅ Sim
`referenceId`	`string`	ID de referência para rastreamento	❌ Não

`closeModal`

Fecha o modal de verificação e limpa src do iframe.

Type: Function Returns: void

sdk.closeModal();

`setLang`

Altera o idioma do fluxo de verificação. Atualmente ignorado pelo front.

Type: Function Parameters: string Returns: void

sdk.setLang("en");
 
sdk.setLang("pt");

`checkCPF`

Valida se um CPF é válido.

Type: Function Parameters: string Returns: boolean

const isValid = sdk.checkCPF("123.456.789-09");
console.log(isValid); // true
 
const isInvalid = sdk.checkCPF("000.000.000-00");
console.log(isInvalid); // false
 
const alsoValid = sdk.checkCPF("12345678909"); // aceita com ou sem formatação

Veja Também

Opções de Configuração - Todas as opções disponíveis ao inicializar o SDK
Campos e Ações - IDs padrão de campos e ações
Funcionalidades - Documentação detalhada de cada funcionalidade

Dicas de UX Opções de Configuração