Arva Platform

Get a customer by ID

To fetch the status of a customer by ID, you must send a GET request to the following endpoint:

https://platform.arva.ai/api/v0/customer/getById?id=<CUSTOMER_ID>

You must provide the customer ID as an id parameter in the query string.

curl -X GET "https://platform.arva.ai/api/v0/customer/getById?id=<CUSTOMER_ID>" -H "Authorization: Bearer <API_KEY>"

npm i @arva-ai/sdk

const arva = require('arva-ai')

const client = new arva.Client({
  apiKey: '<API_KEY>',
})

const customer = await client.customer.getById('<CUSTOMER_ID>')

import requests

response = requests.get('https://platform.arva.ai/api/v0/customer/getById?id=<CUSTOMER_ID>', headers={'Authorization': 'Bearer <API_KEY>'})

customer = response.json()

pip install arva-sdk

from arva import Client

client = Client(api_key='<API_KEY>')

customer = client.customer.get_by_id('<CUSTOMER_ID>')

The response will be a JSON object with the following fields:

{
  id: string // customer ID
  name: string
  state: string | undefined
  createdAt: Date
  verdict: 'ACCEPT' | 'REJECT' | 'REQUEST_INFORMATION' | 'PENDING'
  riskLevel: 'HIGH' | 'MEDIUM' | 'LOW' | undefined
  periodicReviewYears: number | undefined // undefined unless the verdict is ACCEPT
  rfi: string | undefined // undefined unless the verdict is REQUEST_INFORMATION
  requiresManualReview: boolean
  checks: {
    type: string
    verdict: 'ACCEPT' | 'REJECT' | 'REQUEST_INFORMATION' | 'PENDING'
    riskLevel: 'HIGH' | 'MEDIUM' | 'LOW' | undefined // undefined unless the verdict is ACCEPT
    reason: string
    periodicReviewYears: number | undefined // undefined unless the verdict is ACCEPT
    requiresManualReview: boolean
    proofs: Proof[]
  }[]
}

Where:

type Proof = {
  id: string
  type: 'DOCUMENT' | 'WEBSITE'
  inferredType: string
  name: string
  url: string
}

type RegistryResult = {
  registeredName: string
  jurisdictionCode: string
  identifier: string
  type: string
  status: string
  inactive: boolean
  dateOfCreation: string
  isForeign: boolean
  registryName: string
  registryUrl: string
  directors: Director[]
  ultimateBeneficialOwners: UltimateBeneficialOwner[]
}

type TinResult = {
  match: boolean
}

type ScreeningResult = {
  hits: {
    matchingName: string
    names: string[]
    lists: {
      name: string
      identifier: string
      url: string
      countryCodes: string[]
      dateAdded: string
    }[]
  }[]
}