Introducing THE OWNLI API

Getting Started With the Ownli API

OpenAPI definition

Vehicle
Admin
Check-in
Reward
Photo
File
- Upload a filepost
- Retrieve fileget
User

Introducing THE OWNLI API

Getting Started With the Ownli API

OpenAPI definition

Vehicle
Admin
Check-in
Reward
Photo
File
- Upload a filepost
- Retrieve fileget
User

Retrieve a proof of address check-in.

get https://api.sandbox.ownli.app/api/users/checkin/proof-of-address/{id}

URL Expired

The URL for this request expired after 30 days.

Path Params

string

required

The id of the checkin

Headers

partnerId

string

required

Partner Id

clientId

string

required

Client Id

clientSecret

string

required

Client Secret

Responses

Response body

object

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

Status of the check-in

Confirmed Declined OnHold Pending

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

Document Type

UtilityBill Paycheck FinancialStatement SaleDeed LeaseAgreement Invalid

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

documents

array of objects

The document(s)

documents

object

url

string

URL of the document

type

string

Type of the document.

DOCUMENT GALLERY CAMERA INVALID

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

array of objects

The photos of the vehicle taken from different angles

photos

object

photoUrl

string

URL of the photo

type

string

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

FrontView AlternateView

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

401

Authorization error e.g. due to an invalid or missing API keys.

Response body

object

error_code

string

Error code

error_message

string

A verbose error message

Response body

object

error_code

string

Error code

error_message

string

A verbose error message

Response body

object

error_code

string

Error code

error_message

string

A verbose error message

Updated about 2 months ago

Update a condition check-in.

Update a proof of address check-in.

Did this page help you?

Language


xxxxxxxxxx
1
curl --request GET \
2
     --url https://api.sandbox.ownli.app/api/users/checkin/proof-of-address/id \
3
     --header 'accept: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

Updated about 2 months ago

Update a condition check-in.

Update a proof of address check-in.

Did this page help you?

Introducing THE OWNLI API
Getting Started With the Ownli API

OpenAPI definition
Vehicle
Retrieve a list of vehicles for a user (by code)get
Retrieve a list of vehicles for a user (by user id)get
Retrieve a list of vehicles for a user (by phone)get
Retrieve a vehicle (by id)get
Retrieve an active vehicle (by license and state)get
Retrieve an active vehicle (by VIN)get
List all vehicles.get
Create a vehicle (by license plate and state)post
Create a vehicle using a VINpost
Update Vehicleput
Admin
List all condition check-ins.get
List all mileage check-ins.get
List all Proof of address check-ins.get
List all payouts.get
List all rewards.get
List all users.get
Retrieve a summary of all check-ins for a userget
Create a userpost
List all users.get
Update user with policy detailsput
Update a userput
Reactivate a vehicleput
Deactivate a vehicleput
Check-in
Retrieve a list of proof of address check-ins for a userget
Retrieve a summary of all proof-of-address check-ins for a userget
Retrieve a summary of all check-ins for a vehicleget
Retrieve a list of condition check-ins for a vehicleget
Retrieve a list of mileage check-ins for a vehicleget
Create a proof of address check-in.post
Create a condition check-in.post
Create a mileage check-in.post
Update a proof of address check-in.put
Retrieve a proof of address check-in.get
Update a condition check-in.put
Retrieve a condition check-in.get
Update a mileage check-in.put
Retrieve a mileage check-in.get
Reward
Retrieve list of productsget
Retrieve payouts claimed by user (by id)get
Retrieve a list of confirmed rewards given to the user (by id)get
Retrieve a list of rewards given to the user (by id)get
Retrieve payouts claimed by user (by phone)get
Retrieve a list of rewards given to the user (by phone)get
Claim rewards on behalf of the userpost
Photo
Retrieve photoget
Retrieve a list of photos for a user (by id)get
Retrieve a list of photos for a user (by phone)get
Upload a photopost
File
Retrieve fileget
Upload a filepost
User
Retrieve a user (by partner code)get
Retrieve a user (by email address)get
Retrieve a user (by id)get
Retrieve a user (by license plate number and state)get
Retrieve a user (by phone number)get

Introducing THE OWNLI API
Getting Started With the Ownli API

OpenAPI definition
Vehicle
Retrieve a list of vehicles for a user (by code)get
Retrieve a list of vehicles for a user (by user id)get
Retrieve a list of vehicles for a user (by phone)get
Retrieve a vehicle (by id)get
Retrieve an active vehicle (by license and state)get
Retrieve an active vehicle (by VIN)get
List all vehicles.get
Create a vehicle (by license plate and state)post
Create a vehicle using a VINpost
Update Vehicleput
Admin
List all condition check-ins.get
List all mileage check-ins.get
List all Proof of address check-ins.get
List all payouts.get
List all rewards.get
List all users.get
Retrieve a summary of all check-ins for a userget
Create a userpost
List all users.get
Update user with policy detailsput
Update a userput
Reactivate a vehicleput
Deactivate a vehicleput
Check-in
Retrieve a list of proof of address check-ins for a userget
Retrieve a summary of all proof-of-address check-ins for a userget
Retrieve a summary of all check-ins for a vehicleget
Retrieve a list of condition check-ins for a vehicleget
Retrieve a list of mileage check-ins for a vehicleget
Create a proof of address check-in.post
Create a condition check-in.post
Create a mileage check-in.post
Update a proof of address check-in.put
Retrieve a proof of address check-in.get
Update a condition check-in.put
Retrieve a condition check-in.get
Update a mileage check-in.put
Retrieve a mileage check-in.get
Reward
Retrieve list of productsget
Retrieve payouts claimed by user (by id)get
Retrieve a list of confirmed rewards given to the user (by id)get
Retrieve a list of rewards given to the user (by id)get
Retrieve payouts claimed by user (by phone)get
Retrieve a list of rewards given to the user (by phone)get
Claim rewards on behalf of the userpost
Photo
Retrieve photoget
Retrieve a list of photos for a user (by id)get
Retrieve a list of photos for a user (by phone)get
Upload a photopost
File
Retrieve fileget
Upload a filepost
User
Retrieve a user (by partner code)get
Retrieve a user (by email address)get
Retrieve a user (by id)get
Retrieve a user (by license plate number and state)get
Retrieve a user (by phone number)get

200The check-in object requested.

403Forbidden. Possible error codes ERROR_NO_PERMISSIONS_TO_RESOURCE

404Check-in not found or or owning User not found. Possible error codes ERROR_USER_NOT_FOUND ERROR_CHECKIN_NOT_FOUND

500Internal error. Possible error codes INTERNAL_SERVER_ERROR