Skip to main content

Retrieve a proof of address check-in.

GET 
/api/users/checkin/proof-of-address/:id

Retrieve a proof of address check-in.

Request​

Path Parameters

    id stringrequired

    The id of the checkin

Responses​

The check-in object requested.

Schema

    id string

    Id of the checkin

    userNote string

    User generated note. For communication between the user to the admin

    adminNote string

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

    checkedInAt string

    Check-in date

    checkInStatus string

    Possible values: [Confirmed, Declined, OnHold, Pending]

    Status of the check-in

    updated string

    Last updated on

    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

    documentType string

    Possible values: [UtilityBill, Paycheck, FinancialStatement, SaleDeed, LeaseAgreement, PhoneBill, Invalid]

    Document Type

    insights

    object

    Insights gathered from the uploaded document(s)

    firstName string

    First name on document(s)

    lastName string

    Last name on document(s)

    address

    object

    Address

    addressLine1 string

    Street Address Line 1

    addressLine2 string

    Street Address Line 2

    city string

    City

    state string

    2 Letter State Code

    country string

    2 Letter Country Code

    zip string

    Zip

    documents

    object[]

    The document(s)

  • Array [

    • url string

    URL of the document

    type string

    Possible values: [DOCUMENT, GALLERY, CAMERA, INVALID, CAMERA, DOCUMENT, GALLERY]

    Type of the document.

    latitude double

    Latitude at which photo was taken

    longitude double

    Longitude at which photo was taken

    markedInvalidByReview boolean

    Indicates that the document has been marked invalid on review.

  • ]

    • photos

    object[]

    The photos of the vehicle taken from different angles

  • Array [

    • photoUrl string

    URL of the photo

    type string

    Possible values: [FrontView, AlternateView]

    Type of the photo. A value from one of the proof of address checkin photo types.

    latitude double

    Latitude at which photo was taken

    longitude double

    Longitude at which photo was taken

    markedInvalidByReview boolean

    Indicates that the photo has been marked invalid on review.

  • ]

    • latitude double

    Latitude at which check-in was done

    longitude double

    Longitude at which check-in was done

    fraud boolean
Loading...