Customers

Manage your customers

Get All Customers

Fetch a list of all your customers

GET https://api.mycover.ai/v1/customers

Query Parameters

NameTypeDescription

page

string

Page number of response

limit

string

Number of data to show per fetch

search

string

Search key word

active

boolean

Find active customers

start_date

string

Filter customers by date

end_date

string

Filter customers by date

Response

{
    "responseCode": 1,
    "responseText": "Customers Retrieved!",
    "data": {
        "customers": [
            {
                "id": "9dc7609b-0609-4df9-96db-f0472d208cf2",
                "app_mode": "test",
                "first_name": "jennifer",
                "business_id": "10cd1dac-3a5c-43ee-b935-641d53f9cb27",
                "user_id": "eb5ffee3-adc0-4bec-8ce3-7d556ed8c6ea",
                "last_name": "onye",
                "email": "jenny.onye@gmail.com",
                "phone_number": "07064378577",
                "country": null,
                "gender": null,
                "title": null,
                "date_of_birth": null,
                "state_of_residence": null,
                "city": null,
                "address": null,
                "identity_verification": null,
                "verification_type": null,
                "face_image": null,
                "is_kyc_complete": false,
                "active": false,
                "created_at": "2024-03-01T15:15:48.888Z",
                "updated_at": "2024-03-01T15:15:49.105Z",
                "deleted_at": null
            },
            {
                "id": "077e276f-f9b4-4e81-9830-25a464d49ef3",
                "app_mode": "test",
                "first_name": "Jon",
                "business_id": "10cd1dac-3a5c-43ee-b935-641d53f9cb27",
                "user_id": "c840020a-3467-44a0-9085-941c81625c50",
                "last_name": "Snow",
                "email": "jonsnow566@gmail.com",
                "phone_number": "08123457651",
                "country": null,
                "gender": null,
                "title": null,
                "date_of_birth": null,
                "state_of_residence": null,
                "city": null,
                "address": null,
                "identity_verification": null,
                "verification_type": null,
                "face_image": null,
                "is_kyc_complete": false,
                "active": false,
                "created_at": "2024-02-22T12:39:42.733Z",
                "updated_at": "2024-02-22T12:39:43.050Z",
                "deleted_at": null
            }
        ],
        "total_count": 15
    }
}

View Active Customers

See a list of customers that have purchased a product

GET https://api.mycover.ai/v1/customers/has-purchased

Query Parameters

NameTypeDescription

page

string

Page number of response

limit

string

Number of data to show per fetch

{
   "responseCode":1,
   "responseText":"Customers Retrieved!",
   "data":{
      "customers":[
         {
            "id":"5646b472-da75-4e65-b296-b28cb2494d46",
            "first_name":"Rhea",
            "business_id":"76d5970a-d46b-43df-beb3-8f3117b7a60f",
            "user_id":"a9295ab5-8db9-47a2-a926-3fa11a219e62",
            "last_name":"Spears",
            "email":"beem24com@gmail.com",
            "phone_number":"+1 (276) 942-9301",
            "country":null,
            "gender":null,
            "title":null,
            "date_of_birth":null,
            "state_of_residence":null,
            "city":null,
            "address":null,
            "identity_verification":null,
            "verification_type":null,
            "face_image":null,
            "is_kyc_complete":false,
            "active":false,
            "wallet_id":"dfcf1108-a9ef-4982-bec2-48cc653dcebc",
            "created_at":"2022-02-22T15:14:16.109Z",
            "updated_at":"2022-02-22T15:14:16.210Z"
         },
         {
            "id":"479b8b3a-8caf-463a-97fe-24bcaefdeaf0",
            "first_name":"Merrill",
            "business_id":"76d5970a-d46b-43df-beb3-8f3117b7a60f",
            "user_id":"7aaaae89-b1ef-4fd7-a314-87e320892faf",
            "last_name":"Rosales",
            "email":"dby45432@mzico.com",
            "phone_number":"+1 (312) 136-4329",
            "country":null,
            "gender":null,
            "title":null,
            "date_of_birth":null,
            "state_of_residence":null,
            "city":null,
            "address":null,
            "identity_verification":null,
            "verification_type":null,
            "face_image":null,
            "is_kyc_complete":false,
            "active":false,
            "wallet_id":"6992a3a4-f215-4232-bee5-6c5021926d19",
            "created_at":"2022-03-01T11:16:25.965Z",
            "updated_at":"2022-03-01T11:16:26.106Z"
         }
      ],
      "total_count":23
   }
}

View Customer Details by ID

View Customer Details by unique customer ID

GET https://api.mycover.ai/v1/customers/{customer_id}

{
   "responseCode":1,
   "responseText":"Customer fetched successfully",
   "data":{
      "customer":{
         "id":"5789b330-2077-496b-bcf9-e75152f2b925",
         "first_name":"Flynn",
         "business_id":"76d5970a-d46b-43df-beb3-8f3117b7a60f",
         "user_id":"6c64540d-a789-4d62-9d6b-c533ddfbcb16",
         "last_name":"Knowles",
         "email":"zagyfiwi@mailinator.com",
         "phone_number":"+1 (637) 901-9226",
         "country":null,
         "gender":null,
         "title":null,
         "date_of_birth":null,
         "state_of_residence":null,
         "city":null,
         "address":null,
         "identity_verification":null,
         "verification_type":null,
         "face_image":null,
         "is_kyc_complete":false,
         "active":false,
         "wallet_id":"8d87eb87-363b-4723-897c-28160a0dc2e3",
         "created_at":"2022-03-08T15:34:38.296Z",
         "updated_at":"2022-03-08T15:34:38.406Z"
      }
   }
}

View Purchase History

See customer’s purchase details, dates and transaction info

GET https://api.mycover.ai/v1/customers/purchases/{customer_id}

Query Parameters

NameTypeDescription

page

string

Page number of response

limit

string

Number of data to show per fetch

{
   "responseCode":1,
   "responseText":"Customers purchase retrieved!",
   "data":{
      "purchases":[
         {
            "purchase_id":"a9e83085-bc1d-44a7-b974-f68066e72a8e",
            "purchase_created_at":"2022-03-08T15:34:58.577Z",
            "purchase_total":"5000.00",
            "product_name":"Aiico Third Party Only",
            "productCategory_name":"Auto",
            "provider_company_name":"Aiico",
            "customer_id":"5789b330-2077-496b-bcf9-e75152f2b925",
            "customer_first_name":"Flynn",
            "customer_business_id":"76d5970a-d46b-43df-beb3-8f3117b7a60f",
            "customer_user_id":"6c64540d-a789-4d62-9d6b-c533ddfbcb16",
            "customer_last_name":"Knowles",
            "customer_email":"zagyfiwi@mailinator.com",
            "customer_phone_number":"+1 (637) 901-9226",
            "customer_country":null,
            "customer_gender":null,
            "customer_title":null,
            "customer_date_of_birth":null,
            "customer_state_of_residence":null,
            "customer_city":null,
            "customer_address":null,
            "customer_identity_verification":null,
            "customer_verification_type":null,
            "customer_face_image":null,
            "customer_is_kyc_complete":false,
            "customer_active":false,
            "customer_wallet_id":"8d87eb87-363b-4723-897c-28160a0dc2e3",
            "customer_created_at":"2022-03-08T15:34:38.296Z",
            "customer_updated_at":"2022-03-08T15:34:38.406Z",
            "total_count":"1"
         }
      ],
      "total_count":1
   }
}

View Customer Renewals

See customer’s renewal details, dates and transaction info

GET https://api.mycover.ai/v1/customers/renewals/{customer_id}

Query Parameters

NameTypeDescription

page

string

Page number of response

limit

string

Number of data to show per fetch

{
   "responseCode":1,
   "responseText":"Customers renewal retrieved!",
   "data":{
      "renewals":[
         
      ],
      "total_count":0
   }
}

View Policies

See customer’s policy details, dates and transaction info

GET https://api.mycover.ai/v1/customers/policies/{customer_id}

Query Parameters

NameTypeDescription

page

string

Page number of response

limit

string

Number of data to show per fetch

{
   "responseCode":1,
   "responseText":"Customers policies retrieved!",
   "data":{
      "policies":[
         {
            "policies_id":"65b09302-26de-42b4-80d9-8b137130d3dd",
            "policies_market_price":"5000.00",
            "policies_genius_price":"5000.00",
            "policies_created_at":"2022-03-08T15:34:58.682Z",
            "product_name":"Aiico Third Party Only",
            "provider_company_name":"Aiico",
            "customer_id":"5789b330-2077-496b-bcf9-e75152f2b925",
            "customer_first_name":"Flynn",
            "customer_business_id":"76d5970a-d46b-43df-beb3-8f3117b7a60f",
            "customer_user_id":"6c64540d-a789-4d62-9d6b-c533ddfbcb16",
            "customer_last_name":"Knowles",
            "customer_email":"zagyfiwi@mailinator.com",
            "customer_phone_number":"+1 (637) 901-9226",
            "customer_country":null,
            "customer_gender":null,
            "customer_title":null,
            "customer_date_of_birth":null,
            "customer_state_of_residence":null,
            "customer_city":null,
            "customer_address":null,
            "customer_identity_verification":null,
            "customer_verification_type":null,
            "customer_face_image":null,
            "customer_is_kyc_complete":false,
            "customer_active":false,
            "customer_wallet_id":"8d87eb87-363b-4723-897c-28160a0dc2e3",
            "customer_created_at":"2022-03-08T15:34:38.296Z",
            "customer_updated_at":"2022-03-08T15:34:38.406Z",
            "total_count":"1"
         }
      ],
      "total_count":1
   }
}

View Claims

List claims made by customers

GET https://api.mycover.ai/v1/customers/claims/{customer_id}

Query Parameters

NameTypeDescription

page

string

Page number of response

limit

string

Number of data to show per fetch

{
   "responseCode":1,
   "responseText":"Customers claims retrieved!",
   "data":{
      "claims":[
         {
            "claims_id":"3bc46e4d-a007-4384-ae75-0ffb62d6848f",
            "claims_claim_amount":"0.00",
            "claims_offer_amount":"0.00",
            "claims_created_at":"2022-03-03T06:23:49.204Z",
            "product_name":"Leadway Comprehensive",
            "provider_company_name":"Wiley Bryan LLC",
            "customer_id":"5646b472-da75-4e65-b296-b28cb2494d46",
            "customer_first_name":"Rhea",
            "customer_business_id":"76d5970a-d46b-43df-beb3-8f3117b7a60f",
            "customer_user_id":"a9295ab5-8db9-47a2-a926-3fa11a219e62",
            "customer_last_name":"Spears",
            "customer_email":"beem24com@gmail.com",
            "customer_phone_number":"+1 (276) 942-9301",
            "customer_country":null,
            "customer_gender":null,
            "customer_title":null,
            "customer_date_of_birth":null,
            "customer_state_of_residence":null,
            "customer_city":null,
            "customer_address":null,
            "customer_identity_verification":null,
            "customer_verification_type":null,
            "customer_face_image":null,
            "customer_is_kyc_complete":false,
            "customer_active":false,
            "customer_wallet_id":"dfcf1108-a9ef-4982-bec2-48cc653dcebc",
            "customer_created_at":"2022-02-22T15:14:16.109Z",
            "customer_updated_at":"2022-02-22T15:14:16.210Z",
            "total_count":"1"
         }
      ],
      "total_count":1
   }
}
PreviousTransactionsNextAuxiliary

Last updated