Capvant

Read a customer

get
https://sandbox.capvant.com/partner/v1/customers/{id}
GET
/customers/{id}

One customer by your partner_customer_id, with its latest eligibility answer.

Authorization

AuthorizationBearer <token>

An access token from POST /oauth/token. Valid for one hour. Preferred, because a leaked request log then exposes an hour rather than a permanent credential.

In: header

Path Parameters

id*string

Your partner_customer_id.

Lengthlength <= 120

Response Body

application/json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

Shell
curl -X GET "https://sandbox.capvant.com/customers/string"
JSON
{  "object": "customer",  "partner_customer_id": "string",  "environment": "live",  "market": "UK",  "company_number": "string",  "business_name": "string",  "eligibility": {    "band": "likely",    "confidence": "high",    "headline": "string",    "reason": "string",    "families": [      {}    ],    "next_best_action": {},    "cautions": [      {}    ],    "register_as_of": "2019-08-24"  },  "eligibility_checked_at": "2019-08-24T14:15:22Z",  "eligibility_changed_at": "2019-08-24T14:15:22Z",  "next_check_at": "2019-08-24T14:15:22Z",  "created_at": "2019-08-24T14:15:22Z",  "updated_at": "2019-08-24T14:15:22Z"}