Skip to main content

Customer profile data

End-point to fetch customer's profile or documents like insurance, DL and credit card uploaded by the customer for a trip

Path Parameters
    trip_uuid string required

    Unique identifier for a trip

Header Parameters
    authorization string required

    Base64 encoded basic auth

Request Body required

request

    dealerDepartmentUUIDList string[]
    requesterUserUUID string
    source string

    Possible values: [DEALER_APP, WEB, PND_API, EXTERNAL_CONTROLLER]

Responses

OK


Schema
    error object
    errorCode string
    errorDescription string
    metadata object
    property name* string
    metadata object
    customerProfileUrls object[]
  • Array [
  • isValid boolean
    status string

    Possible values: [UPLOAD_PENDING, VERIFICATION_PENDING, VERIFIED, REQUEST_ITEMS, VERIFY_ITEMS, PREVIEW_ITEMS]

    token string
    url string
    vaultPiiDataStoreUuid string
  • ]
  • eventUuid string
    statusCode int32
    warnings object[]
  • Array [
  • warningCode string
    warningDescription string
  • ]
POST /v3/trip/:trip_uuid/metadata

Request

Base URL
//api.mykaarma.com/pickupdelivery
trip_uuid — path required
authorization — header required
Body required
{
"dealerDepartmentUUIDList": [
"string"
],
"requesterUserUUID": "string",
"source": "DEALER_APP"
}
curl / cURL
curl -L -X POST '//api.mykaarma.com/pickupdelivery/v3/trip/:trip_uuid/metadata' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
"dealerDepartmentUUIDList": [
"string"
],
"requesterUserUUID": "string",
"source": "DEALER_APP"
}'