AddressCheck

Analytics

Nossos SDKs por padrão coletam informações sobre o usuário e ambiente em execução para melhorar o mapeamento de fraudadores e entender seus comportamentos. Recomendamos manter essa coleta ativa pois o único intuito desses dados é para redução de fraudes, mas se desejar, você desabilitar pelo parâmetro .setAnalyticsSettings(boolean useAnalytics).

Permissões necessárias

No arquivo info.plist, adicione as permissões abaixo:

Privacy - Location Always and When In Use Usage Description
Privacy - Location Always Usage Description
Privacy - Location Usage Description
Privacy - Location When In Use Usage Description

Permissões em tempo de execução

Permissão	Motivo	Obrigatória?
LocationAlwaysAuthorization	Para verificar em segundo plano se o usuário mora onde informou	Sim

Inicializando o SDK

No método application:didFinishLaunchingWithOptions: do seu arquivo AppDelegate, insira:

import AddressCheck

@UIApplicationMain
class AppDelegate: UIResponder, UIApplicationDelegate {

  func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplicationLaunchOptionsKey: Any]?) -> Bool {
    
    //Inicializa SDK
    AddressCheck.initSDK()
    
    return true
  }
}

Como utilizar

Primeiro, crie um objeto do tipo AddressCheck. Este objeto serve para você configurar todos as suas regras de negócio para a comprovação do endereço:

let AddressCheck = new AddressCheck.Builder(mobileToken: mobileToken, peopleId: peopleId)
    // veja a tabela abaixo
    .build();

Parâmetro	Descrição	Obrigatório?
mobileToken: String Token de utilização associado à sua conta da CAF	Sim
peopleId: String Identificador do usuário cujo endereço está sendo validado	Sim
.setAnalyticsSettings(boolean useAnalytics) Habilita/desabilita a coleta de dados para o analytics	Não, o padrão é true
.setNetworkSettings(int requestTimeout) Altera as configurações de rede padrão	Não. O padrão é 60 (segundos)

Com este objeto criado, e após coletar o endereço informado por seu usuário, implemente o delegate, e seus métodos obrigatórios, AddressCollectionDelegate à sua clase, crie um objeto do tipo AddressCollection, passando o objeto criado anteriormente, e atribua o endereço, como no exemplo:

  let addressCollection = AddressCollection(addressCheck: addressCheck)
            
  addressCollection.delegate = self

  let address = Address()
  // veja a tabela abaixo

  addressCollection.setAddress(address)

Address

Para submissão do endereço, você deve informar os seguintes campos:

Address address = new Address()
address.locale = Locale.init(identifier: "pt-br")
address.countryName = COUNTRY_NAME
address.countryCode = COUNTRY_CODE
address.adminArea = ADMIN_AREA
address.subAdminArea = SUB_ADMIN_AREA
address.locality = LOCALITY
address.subLocality = SUB_LOCALITY
address.thoroughfare = THOROUGHFARE
address.subThoroughfare = SUB_THOROUGHFARE
address.postalCode = POSTAL_CODE

Parâmetro	Exemplo
countryName Nome do país	"Brasil"
countryCode Código do país	"BR"
adminArea Estado	"Rio Grande do Sul"
subAdminArea Região do estado	"Porto Alegre"
locality Cidade	"Porto Alegre"
subLocality Bairro	"Azenha"
thoroughfare Rua/Av.	"Av. Azenha"
subThoroughfare Número	"200"
postalCode CEP	"51110-100"

Pronto! Após isso, nosso SDK já está avaliando em segundo plano a localização do seu usuário para verificar se ele realmente mora no endereço informado.

Verificando o status da validação do endereço

Para verificar o status da validação do endereço, use a seguinte rota:

Recurso: https://api.mobile.combateafraude.com/address/{peopleId}?project=ios
Método: GET

Resposta

Status: 200 (OK)

Body

Campo	Tipo	Obrigatório	Descrição
last_activity_ts	number	Sim	Timestamp da última atualização
installations	object	Não	Dispositivo(s) onde esse user ID foi usado
address_verification	object	Não	Verificação do(s) endereço(s)