@guilhermeselis/shiel-id-sdk
v1.0.1
Published
Shield ID KYC SDK for React Native
Downloads
101
Maintainers
Readme
Shield ID KYC Library
Biblioteca React Native para integração com o fluxo de verificação de identidade (KYC) do Shield ID.
Instalação
npm install @guilhermeselis/shiel-id-sdk react-native-webview
# ou
yarn add @guilhermeselis/shiel-id-sdk react-native-webviewUso Básico
import { ShieldIdKyc } from '@guilhermeselis/shiel-id-sdk';
function MyVerificationScreen() {
return (
<ShieldIdKyc
hashChecker="SEU_HASH_CHECKER"
hash="SEU_HASH_UNICO"
onSuccess={() => console.log('Verificação aprovada!')}
onRejected={() => console.log('Verificação rejeitada.')}
onError={(e) => console.error('Erro no carregamento', e)}
/>
);
}Props (Parâmetros)
| Prop | Tipo | Obrigatório | Descrição |
|------|------|-------------|-----------|
| hashChecker | string | Sim | O identificador do verificador (parte da URL após /kyc/). |
| hash | string | Sim | O hash único da sessão de verificação (parte final da URL). |
| onSuccess | () => void | Não | Função chamada quando a verificação é concluída com sucesso (status "approved"). |
| onRejected | () => void | Não | Função chamada quando a verificação é rejeitada (status "rejected"). |
| onError | (error: any) => void | Não | Função chamada caso ocorra um erro no carregamento da WebView. |
| baseUrl | string | Não | URL base do serviço. Padrão: https://shielid.com/kyc. |
| style | ViewStyle | Não | Estilos customizados para o container da WebView. |
Funcionamento
O componente renderiza uma WebView que carrega a URL montada no formato:
${baseUrl}/${hashChecker}/${hash}
Ele injeta scripts automaticamente para interceptar mensagens postMessage do iframe do Shield ID e repassá-las para o React Native, permitindo detectar quando o processo foi aprovado ou rejeitado.
