CreateAddressVerificationJobRequest

  • country_code
    Type: string
    min length:  
    2
    max length:  
    2
    required

    ISO 3166-1 alpha-2 country code

  • customer_ref
    Type: string
    min length:  
    1
    required

    Your unique reference for this customer

  • claimed_label
    Type: string

    Human-readable label for the claimed location

  • claimed_lat
    Type: number

    Claimed home latitude (default 0 if not yet known)

  • claimed_lng
    Type: number

    Claimed home longitude (default 0 if not yet known)

  • observation_days
    Type: integer
    min:  
    3
    max:  
    90

    Number of nights to observe (default 14)

  • radius_meters
    Type: integer

    GPS match radius in metres (default 100)

  • tracking_window_end
    Type: string

    End of nightly observation window (HH:MM, default 06:00)

  • tracking_window_start
    Type: string

    Start of nightly observation window (HH:MM, default 20:00)

  • verdict_thresholds
    Type: object

    Custom score thresholds for HIGH/MODERATE verdicts

    • high
      Type: integer
      required

      Integer numbers.

    • moderate
      Type: integer
      required

      Integer numbers.