Skip to main content

Retrieve a summary of all proof-of-address check-ins for a user

GET 
/api/users/:userId/proof-of-address/checkin-summary

Retrieve a summary of all proof-of-address check-ins for a vehicle.

Request​

Path Parameters

    userId stringrequired

Responses​

A summary of proof-of-address check-in information about the user.

Schema

  • Array [

    • checkins

    object[]

    List of all check-ins

  • Array [

    • id string

    Id of the check-in

    checkInType string

    Type of the check-in

    status string

    Status of the check-in

    checkinDate string

    Timestamp of the check-in

    adminNote string

    Admin generated note. Usually used for on-hold or declined check-ins

    reward

    object

    Reward associated with the check-in

    id string

    Id of the reward

    status string

    Possible values: [Pending, Confirmed, Declined, Claimed, All]

    Status of the reward

    dateRewarded string

    Date on which reward was created

    amount double

    address

    object

    Address

    addressLine1 string

    Street Address Line 1

    city string

    City

    state string

    2 Letter State Code

    country string

    2 Letter Country Code

    zip string

    Zip

    latitude double

    Latitude at which photo was taken

    longitude double

    Longitude at which photo was taken

  • ]

    • checkinUnlocked boolean

    Is a check-in unlocked.

    unlockDate string

    If the check-in is unlocked, the time at which it was unlocked.

    daysToNextCheckin int64

    Number of days to next check-in.

    rewardAmountForNextCheckin double

    Reward for next check-in based on current campaign setup.

    photoBonusForNextCheckin double

    Bonus for home photos for next check-in based on current campaign setup.

    lastConfirmedOrdinal int32

    The ordinal of the last confirmed check-in. 0 represents no confirmed check-ins

  • ]

Loading...