UBX Marketplace API Documentation
Versions ¶
All notable changes to this project will be documented in this section. This project adheres to Semantic Versioning.
Changelog entries are categorized in the following way:
-
Features — New products or services, including new nodes, edges, and fields.
-
Changes — Changes to existing products or services.
-
Fixes — Fix in documentation formats.
1.7.0
Released - Wednesday, April 21, 2021
Changes
- Request Payload - Reduced mandatory fields for Customer Information. (Note: Some optional fields in the API might be required by the Carrier 3RD party API, or by a specific ProductId)
1.6.0
Released - Wednesday, April 7, 2021
Changes
-
Request Payload - Title as a required field.
-
Description - Change Address field description and Check Status API.
1.5.0
Released - Friday, March 26, 2021
Features
- Request Payload - Added payment object on both Create & Submit API and Create API.
1.4.0
Released - Tuesday, March 2, 2021
Changes
- Request Header - Changed x-api-key to Authorizer, use token from client credential.
1.3.0
Released - Monday, Febuary 19, 2021
Features
-
Create Case - This API will create a case in the marketplace platform.
-
Get Case - This API will be used to get case by referenceId.
1.2.0
Released - Monday, Febuary 8, 2021
Features
- Check Case Status - This API will allow to check the status of a case by referenceId.
1.1.0
Released - Thursday, January 28, 2021
Features
- Errors - Added basic bad request errors and carrier server error.
Changes
- Response - Remove code and message on success response.
1.0.0
Released - Friday, January 15, 2021
Features
-
Create and Submit - This API will create a case in the marketplace platform then submits it to the carrier.
-
Cancel Policy - This API will allow for the cancellation of an existing policy that was registered.
-
Reference - This API will be used on fetching all the possible values for a certain field as reference.
Marketplace API Collection ¶
This section groups Case API resources.
Create and Submit ¶
Create case and submit it to carrier.
Create and SubmitPOST/api/v1/{channelId}/case/submit
Example URI
POST ubx.dev.yellow.coherent.global/api/v1/ubp/case/submit
URI Parameters
- channelId
string(required) Example: ubpId of the channel where the sale configured.
Request
Headers
accept: application/json
content-type: application/json
Authorizer: TokenBody
{
"referenceId": "6473fccd-5dea-48d6-ada8-2e55ac61d21e",
"carrierId": "chubbph",
"policyDetail": {
"productId": "UBXPHEMBCRED00000001",
"effectiveDate": "2020-12-01T00:00:00.000Z",
"expiryDate": "2021-01-01T00:00:00.000Z"
},
"payment": {
"premiumPaid": "100",
"paymentMethod": "bankTransfer",
"currency": "php",
"transactionReference": "6473fccd-5dea-48d6-ada8-2e55ac61d21e1"
},
"applicant": {
"title": "Mr",
"firstName": "Jorge",
"lastName": "Lee",
"email": "Jorge.Lee@gmail.com",
"id": {
"personal": {
"expiryDate": "2021-01-01T00:00:00.000Z",
"number": "1231"
},
"passport": {
"expiryDate": "2021-01-01T00:00:00.000Z",
"number": "1231"
}
},
"phoneNumber": {
"mobile": {
"e123": "+63 927 236 3233"
},
"home": {
"e123": "+63 927 236 3233"
}
},
"dateOfBirth": "2000-01-01T00:00:00.000Z",
"gender": "Male",
"address": {
"home": {
"block": "Block 1",
"street": "Street 1",
"building": "Building 1",
"district": "District 1",
"estate": "Rich Estate",
"flat": "40",
"floor": "4th",
"postCode": "1234",
"city": "City 1",
"province": "Metro Manila",
"country": "Philppines"
},
"work": {
"block": "Block 1",
"street": "Street 1",
"building": "Building 1",
"district": "District 1",
"estate": "Rich Estate",
"flat": "40",
"floor": "4th",
"postCode": "1234",
"city": "City 1",
"province": "Metro Manila",
"country": "Philppines"
},
"postal": {
"block": "Block 1",
"street": "Street 1",
"building": "Building 1",
"district": "District 1",
"estate": "Rich Estate",
"flat": "40",
"floor": "4th",
"postCode": "1234",
"city": "City 1",
"province": "Metro Manila",
"country": "Philppines"
},
"billing": {
"block": "Block 1",
"street": "Street 1",
"building": "Building 1",
"district": "District 1",
"estate": "Rich Estate",
"flat": "40",
"floor": "4th",
"postCode": "1234",
"city": "City 1",
"province": "Metro Manila",
"country": "Philppines"
}
}
},
"insured": [
{
"title": "Mr",
"firstName": "Jorge",
"lastName": "Lee",
"email": "Jorge.Lee@gmail.com",
"id": {
"personal": {
"expiryDate": "2021-01-01T00:00:00.000Z",
"number": "1231"
},
"passport": {
"expiryDate": "2021-01-01T00:00:00.000Z",
"number": "1231"
}
},
"phoneNumber": {
"mobile": {
"e123": "+63 927 236 3233"
},
"home": {
"e123": "+63 927 236 3233"
}
},
"dateOfBirth": "2000-01-01T00:00:00.000Z",
"gender": "Male",
"address": {
"home": {
"block": "Block 1",
"street": "Street 1",
"building": "Building 1",
"district": "District 1",
"estate": "Rich Estate",
"flat": "40",
"floor": "4th",
"postCode": "1234",
"city": "City 1",
"province": "Metro Manila",
"country": "Philppines"
},
"work": {
"block": "Block 1",
"street": "Street 1",
"building": "Building 1",
"district": "District 1",
"estate": "Rich Estate",
"flat": "40",
"floor": "4th",
"postCode": "1234",
"city": "City 1",
"province": "Metro Manila",
"country": "Philppines"
},
"postal": {
"block": "Block 1",
"street": "Street 1",
"building": "Building 1",
"district": "District 1",
"estate": "Rich Estate",
"flat": "40",
"floor": "4th",
"postCode": "1234",
"city": "City 1",
"province": "Metro Manila",
"country": "Philppines"
},
"billing": {
"block": "Block 1",
"street": "Street 1",
"building": "Building 1",
"district": "District 1",
"estate": "Rich Estate",
"flat": "40",
"floor": "4th",
"postCode": "1234",
"city": "City 1",
"province": "Metro Manila",
"country": "Philppines"
}
},
"relationship": {
"toInsured": "self"
}
}
]
}Schema
{
"type": "object",
"properties": {
"referenceId": {
"type": "string",
"description": "Unique Id for the client's reference."
},
"carrierId": {
"type": "string",
"description": "Carrier name."
},
"policyDetail": {
"type": "object",
"properties": {
"productId": {
"type": "string",
"description": "Product id."
},
"effectiveDate": {
"type": "string",
"description": "Date that this agreement is effective from."
},
"expiryDate": {
"type": "string",
"description": "Date that this agreement expires."
}
},
"required": [
"productId",
"effectiveDate",
"expiryDate"
],
"description": "Details of the policy."
},
"payment": {
"type": "object",
"properties": {
"premiumPaid": {
"type": "string",
"description": "Amount paid for premium."
},
"paymentMethod": {
"type": "string",
"description": "Method by which the payment is made."
},
"currency": {
"type": "string",
"description": "Currency of the amount."
},
"transactionReference": {
"type": "string",
"description": "Reference for payment transaction."
}
},
"required": [
"premiumPaid",
"paymentMethod",
"currency"
],
"description": "Details of payment."
},
"applicant": {
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "Title type for this person."
},
"firstName": {
"type": "string",
"description": "First Name for this person."
},
"lastName": {
"type": "string",
"description": "Last Name for this person."
},
"email": {
"type": "string",
"description": "Email for this person."
},
"id": {
"type": "object",
"properties": {
"personal": {
"type": "object",
"properties": {
"expiryDate": {
"type": "string",
"description": "Expriy Date of this id."
},
"number": {
"type": "string",
"description": "Value for this id."
}
},
"required": [
"number"
]
},
"passport": {
"type": "object",
"properties": {
"expiryDate": {
"type": "string",
"description": "Expriy Date of this id."
},
"number": {
"type": "string",
"description": "Value for this id."
}
},
"required": [
"number"
]
}
},
"required": [
"personal"
],
"description": "Identification Documents for this person"
},
"phoneNumber": {
"type": "object",
"properties": {
"mobile": {
"type": "object",
"properties": {
"e123": {
"type": "string"
}
},
"required": [
"e123"
]
},
"home": {
"type": "object",
"properties": {
"e123": {
"type": "string"
}
},
"required": [
"e123"
]
}
},
"required": [
"mobile"
],
"description": "Contact details."
},
"dateOfBirth": {
"type": "string",
"description": "Date of birth."
},
"gender": {
"type": "string",
"description": "Gender for this person."
},
"address": {
"type": "object",
"properties": {
"home": {
"type": "object",
"properties": {
"block": {
"type": "string",
"description": "Block name."
},
"street": {
"type": "string",
"description": "Street name."
},
"building": {
"type": "string",
"description": "Building name."
},
"district": {
"type": "string",
"description": "Area of the country or city."
},
"estate": {
"type": "string",
"description": "Estate name."
},
"flat": {
"type": "string",
"description": "Unit or Room."
},
"floor": {
"type": "string",
"description": "Floor number."
},
"postCode": {
"type": "string",
"description": "Postal Code."
},
"city": {
"type": "string",
"description": "Name of city."
},
"province": {
"type": "string",
"description": "Name of province."
},
"country": {
"type": "string",
"description": "Name of country."
}
},
"required": [
"postCode",
"city",
"province",
"country"
]
},
"work": {
"type": "object",
"properties": {
"block": {
"type": "string",
"description": "Block name."
},
"street": {
"type": "string",
"description": "Street name."
},
"building": {
"type": "string",
"description": "Building name."
},
"district": {
"type": "string",
"description": "Area of the country or city."
},
"estate": {
"type": "string",
"description": "Estate name."
},
"flat": {
"type": "string",
"description": "Unit or Room."
},
"floor": {
"type": "string",
"description": "Floor number."
},
"postCode": {
"type": "string",
"description": "Postal Code."
},
"city": {
"type": "string",
"description": "Name of city."
},
"province": {
"type": "string",
"description": "Name of province."
},
"country": {
"type": "string",
"description": "Name of country."
}
},
"required": [
"postCode",
"city",
"province",
"country"
]
},
"postal": {
"type": "object",
"properties": {
"block": {
"type": "string",
"description": "Block name."
},
"street": {
"type": "string",
"description": "Street name."
},
"building": {
"type": "string",
"description": "Building name."
},
"district": {
"type": "string",
"description": "Area of the country or city."
},
"estate": {
"type": "string",
"description": "Estate name."
},
"flat": {
"type": "string",
"description": "Unit or Room."
},
"floor": {
"type": "string",
"description": "Floor number."
},
"postCode": {
"type": "string",
"description": "Postal Code."
},
"city": {
"type": "string",
"description": "Name of city."
},
"province": {
"type": "string",
"description": "Name of province."
},
"country": {
"type": "string",
"description": "Name of country."
}
},
"required": [
"postCode",
"city",
"province",
"country"
]
},
"billing": {
"type": "object",
"properties": {
"block": {
"type": "string",
"description": "Block name."
},
"street": {
"type": "string",
"description": "Street name."
},
"building": {
"type": "string",
"description": "Building name."
},
"district": {
"type": "string",
"description": "Area of the country or city."
},
"estate": {
"type": "string",
"description": "Estate name."
},
"flat": {
"type": "string",
"description": "Unit or Room."
},
"floor": {
"type": "string",
"description": "Floor number."
},
"postCode": {
"type": "string",
"description": "Postal Code."
},
"city": {
"type": "string",
"description": "Name of city."
},
"province": {
"type": "string",
"description": "Name of province."
},
"country": {
"type": "string",
"description": "Name of country."
}
},
"required": [
"postCode",
"city",
"province",
"country"
]
}
},
"required": [
"home"
],
"description": "Address of the person (Applicant, Insured, Beneficiary). Flat, Floor, Block, Building, Street, District, Estate forms address lines and might be required for some carriers,"
}
},
"required": [
"firstName",
"lastName",
"phoneNumber",
"dateOfBirth"
],
"description": "The applicant aka policy holder/contract holder."
},
"insured": {
"type": "array",
"items": {
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "Title type for this person."
},
"firstName": {
"type": "string",
"description": "First Name for this person."
},
"lastName": {
"type": "string",
"description": "Last Name for this person."
},
"email": {
"type": "string",
"description": "Email for this person."
},
"id": {
"type": "object",
"properties": {
"personal": {
"type": "object",
"properties": {
"expiryDate": {
"type": "string",
"description": "Expriy Date of this id."
},
"number": {
"type": "string",
"description": "Value for this id."
}
},
"required": [
"number"
]
},
"passport": {
"type": "object",
"properties": {
"expiryDate": {
"type": "string",
"description": "Expriy Date of this id."
},
"number": {
"type": "string",
"description": "Value for this id."
}
},
"required": [
"number"
]
}
},
"required": [
"personal"
],
"description": "Identification Documents for this person"
},
"phoneNumber": {
"type": "object",
"properties": {
"mobile": {
"type": "object",
"properties": {
"e123": {
"type": "string"
}
},
"required": [
"e123"
]
},
"home": {
"type": "object",
"properties": {
"e123": {
"type": "string"
}
},
"required": [
"e123"
]
}
},
"required": [
"mobile"
],
"description": "Contact details."
},
"dateOfBirth": {
"type": "string",
"description": "Date of birth."
},
"gender": {
"type": "string",
"description": "Gender for this person."
},
"address": {
"type": "object",
"properties": {
"home": {
"type": "object",
"properties": {
"block": {
"type": "string",
"description": "Block name."
},
"street": {
"type": "string",
"description": "Street name."
},
"building": {
"type": "string",
"description": "Building name."
},
"district": {
"type": "string",
"description": "Area of the country or city."
},
"estate": {
"type": "string",
"description": "Estate name."
},
"flat": {
"type": "string",
"description": "Unit or Room."
},
"floor": {
"type": "string",
"description": "Floor number."
},
"postCode": {
"type": "string",
"description": "Postal Code."
},
"city": {
"type": "string",
"description": "Name of city."
},
"province": {
"type": "string",
"description": "Name of province."
},
"country": {
"type": "string",
"description": "Name of country."
}
},
"required": [
"postCode",
"city",
"province",
"country"
]
},
"work": {
"type": "object",
"properties": {
"block": {
"type": "string",
"description": "Block name."
},
"street": {
"type": "string",
"description": "Street name."
},
"building": {
"type": "string",
"description": "Building name."
},
"district": {
"type": "string",
"description": "Area of the country or city."
},
"estate": {
"type": "string",
"description": "Estate name."
},
"flat": {
"type": "string",
"description": "Unit or Room."
},
"floor": {
"type": "string",
"description": "Floor number."
},
"postCode": {
"type": "string",
"description": "Postal Code."
},
"city": {
"type": "string",
"description": "Name of city."
},
"province": {
"type": "string",
"description": "Name of province."
},
"country": {
"type": "string",
"description": "Name of country."
}
},
"required": [
"postCode",
"city",
"province",
"country"
]
},
"postal": {
"type": "object",
"properties": {
"block": {
"type": "string",
"description": "Block name."
},
"street": {
"type": "string",
"description": "Street name."
},
"building": {
"type": "string",
"description": "Building name."
},
"district": {
"type": "string",
"description": "Area of the country or city."
},
"estate": {
"type": "string",
"description": "Estate name."
},
"flat": {
"type": "string",
"description": "Unit or Room."
},
"floor": {
"type": "string",
"description": "Floor number."
},
"postCode": {
"type": "string",
"description": "Postal Code."
},
"city": {
"type": "string",
"description": "Name of city."
},
"province": {
"type": "string",
"description": "Name of province."
},
"country": {
"type": "string",
"description": "Name of country."
}
},
"required": [
"postCode",
"city",
"province",
"country"
]
},
"billing": {
"type": "object",
"properties": {
"block": {
"type": "string",
"description": "Block name."
},
"street": {
"type": "string",
"description": "Street name."
},
"building": {
"type": "string",
"description": "Building name."
},
"district": {
"type": "string",
"description": "Area of the country or city."
},
"estate": {
"type": "string",
"description": "Estate name."
},
"flat": {
"type": "string",
"description": "Unit or Room."
},
"floor": {
"type": "string",
"description": "Floor number."
},
"postCode": {
"type": "string",
"description": "Postal Code."
},
"city": {
"type": "string",
"description": "Name of city."
},
"province": {
"type": "string",
"description": "Name of province."
},
"country": {
"type": "string",
"description": "Name of country."
}
},
"required": [
"postCode",
"city",
"province",
"country"
]
}
},
"required": [
"home"
],
"description": "Address of the person (Applicant, Insured, Beneficiary). Flat, Floor, Block, Building, Street, District, Estate forms address lines and might be required for some carriers,"
},
"relationship": {
"type": "object",
"properties": {
"toInsured": {
"type": "string"
}
},
"required": [
"toInsured"
]
}
},
"required": [
"firstName",
"lastName",
"phoneNumber",
"dateOfBirth",
"relationship"
]
},
"description": "List of insured entities."
}
},
"required": [
"referenceId",
"carrierId",
"policyDetail",
"applicant",
"insured"
],
"$schema": "http://json-schema.org/draft-04/schema#"
}Response
200Headers
content-type: application/json; charset=utf-8
content-length: 30
x-marketplace-request-id: c13cb6c6-a11c-4513-bf9a-3aa2a59457d9
x-marketplace-request-timestamp: 2017-08-13T22:30:26.000ZBody
{
"data": {
"policyNumber": "UNIPH0002223221",
"policyCertificateUri": "https://apacszonemwdevstrg.blob.core.windows.net/policyartifacts/10003/policies/201809/DGTAUYU8RFQFO2N_.pdf?sv=2016-05-31&sr=b&sig=Hh4jico%2FOCeI0OsgBpRWxkdcAVPfyyTy6ptwBLqECUQ%3D&se=2017-08-18T09%3A31%3A45Z&sp=r",
"policyDetail": {
"productId": "UBXPHEMBCRED00000001",
"effectiveDate": "2020-12-01T00:00:00.000Z",
"expiryDate": "2021-01-01T00:00:00.000Z"
}
}
}Schema
{
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"policyNumber": {
"type": "string",
"description": "This policyNumber is issued by the carrier, not the marketplace platform."
},
"policyCertificateUri": {
"type": "string",
"description": "URI for the COI."
},
"policyDetail": {
"type": "object",
"properties": {
"productId": {
"type": "string",
"description": "Product id."
},
"effectiveDate": {
"type": "string",
"description": "Date that this agreement is effective from."
},
"expiryDate": {
"type": "string",
"description": "Date that this agreement expires."
}
},
"required": [
"productId",
"effectiveDate",
"expiryDate"
]
}
},
"required": [
"policyNumber",
"policyCertificateUri"
]
}
},
"$schema": "http://json-schema.org/draft-04/schema#"
}Response
400Headers
content-type: application/json; charset=utf-8
content-length: 30
x-marketplace-request-id: c13cb6c6-a11c-4513-bf9a-3aa2a59457d9
x-marketplace-request-timestamp: 2017-08-13T22:30:26.000ZBody
{
"code": "EXXX",
"message": "Error details here."
}Schema
{
"type": "object",
"properties": {
"code": {
"type": "string",
"description": "Application error code."
},
"message": {
"type": "string",
"description": "Application error message"
}
},
"required": [
"code",
"message"
],
"$schema": "http://json-schema.org/draft-04/schema#"
}Response
401Headers
content-type: application/json; charset=utf-8
content-length: 30
x-marketplace-request-id: c13cb6c6-a11c-4513-bf9a-3aa2a59457d9
x-marketplace-request-timestamp: 2017-08-13T22:30:26.000ZBody
{
"code": "EXXX",
"message": "Error details here."
}Schema
{
"type": "object",
"properties": {
"code": {
"type": "string",
"description": "Application error code."
},
"message": {
"type": "string",
"description": "Application error message"
}
},
"required": [
"code",
"message"
],
"$schema": "http://json-schema.org/draft-04/schema#"
}Response
500Headers
content-type: application/json; charset=utf-8
content-length: 30
x-marketplace-request-id: c13cb6c6-a11c-4513-bf9a-3aa2a59457d9
x-marketplace-request-timestamp: 2017-08-13T22:30:26.000ZBody
{
"code": "EXXX",
"message": "Error details here."
}Schema
{
"type": "object",
"properties": {
"code": {
"type": "string",
"description": "Application error code."
},
"message": {
"type": "string",
"description": "Application error message"
}
},
"required": [
"code",
"message"
],
"$schema": "http://json-schema.org/draft-04/schema#"
}Cancel ¶
Policy cancellation.
CancelPOST/api/v1/{channelId}/case/{referenceId}/policy/cancel
Example URI
POST ubx.dev.yellow.coherent.global/api/v1/ubp/case/6473fccd-5dea-48d6-ada8-2e55ac61d21e/policy/cancel
URI Parameters
- channelId
string(required) Example: ubpId of the channel where the sale configured.
- referenceId
string(required) Example: 6473fccd-5dea-48d6-ada8-2e55ac61d21eUnique Id used on create case.
Request
Headers
accept: application/json
content-type: application/json
Authorizer: TokenBody
{
"cancellationReason": "INSUFFICIENT_FUNDS",
"cancelledBy": "channel"
}Schema
{
"type": "object",
"properties": {
"cancellationReason": {
"type": "string",
"description": "Cancellation reason. See Reference API and use cancellation_reason on path."
},
"cancelledBy": {
"type": "string",
"description": "Entity who cancelled the policy."
}
},
"required": [
"cancellationReason",
"cancelledBy"
],
"$schema": "http://json-schema.org/draft-04/schema#"
}Response
200Headers
content-type: application/json; charset=utf-8
content-length: 30
x-marketplace-request-id: c13cb6c6-a11c-4513-bf9a-3aa2a59457d9
x-marketplace-request-timestamp: 2017-08-13T22:30:26.000ZBody
{
"data": {
"policyNumber": "UNIPH0002223221",
"policyDetail": {
"productId": "UBXPHEMBCRED00000001",
"effectiveDate": "2020-12-01T00:00:00.000Z",
"expiryDate": "2021-01-01T00:00:00.000Z"
}
}
}Schema
{
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"policyNumber": {
"type": "string",
"description": "This policyNumber is issued by the carrier, not the marketplace platform."
},
"policyDetail": {
"type": "object",
"properties": {
"productId": {
"type": "string",
"description": "Product id."
},
"effectiveDate": {
"type": "string",
"description": "Date that this agreement is effective from."
},
"expiryDate": {
"type": "string",
"description": "Date that this agreement expires."
}
},
"required": [
"productId",
"effectiveDate",
"expiryDate"
]
}
},
"required": [
"policyNumber"
]
}
},
"$schema": "http://json-schema.org/draft-04/schema#"
}Response
400Headers
content-type: application/json; charset=utf-8
content-length: 30
x-marketplace-request-id: c13cb6c6-a11c-4513-bf9a-3aa2a59457d9
x-marketplace-request-timestamp: 2017-08-13T22:30:26.000ZBody
{
"code": "EXXX",
"message": "Error details here."
}Schema
{
"type": "object",
"properties": {
"code": {
"type": "string",
"description": "Application error code."
},
"message": {
"type": "string",
"description": "Application error message"
}
},
"required": [
"code",
"message"
],
"$schema": "http://json-schema.org/draft-04/schema#"
}Response
401Headers
content-type: application/json; charset=utf-8
content-length: 30
x-marketplace-request-id: c13cb6c6-a11c-4513-bf9a-3aa2a59457d9
x-marketplace-request-timestamp: 2017-08-13T22:30:26.000ZBody
{
"code": "EXXX",
"message": "Error details here."
}Schema
{
"type": "object",
"properties": {
"code": {
"type": "string",
"description": "Application error code."
},
"message": {
"type": "string",
"description": "Application error message"
}
},
"required": [
"code",
"message"
],
"$schema": "http://json-schema.org/draft-04/schema#"
}Response
500Headers
content-type: application/json; charset=utf-8
content-length: 30
x-marketplace-request-id: c13cb6c6-a11c-4513-bf9a-3aa2a59457d9
x-marketplace-request-timestamp: 2017-08-13T22:30:26.000ZBody
{
"code": "EXXX",
"message": "Error details here."
}Schema
{
"type": "object",
"properties": {
"code": {
"type": "string",
"description": "Application error code."
},
"message": {
"type": "string",
"description": "Application error message"
}
},
"required": [
"code",
"message"
],
"$schema": "http://json-schema.org/draft-04/schema#"
}Create ¶
Create case.
CreatePOST/api/v1/{channelId}/case
Example URI
POST ubx.dev.yellow.coherent.global/api/v1/ubp/case
URI Parameters
- channelId
string(required) Example: ubpId of the channel where the sale configured.
Request
Headers
accept: application/json
content-type: application/json
Authorizer: TokenBody
{
"referenceId": "6473fccd-5dea-48d6-ada8-2e55ac61d21e",
"carrierId": "chubbph",
"policyDetail": {
"productId": "UBXPHEMBCRED00000001",
"effectiveDate": "2020-12-01T00:00:00.000Z",
"expiryDate": "2021-01-01T00:00:00.000Z"
},
"payment": {
"premiumPaid": "100",
"paymentMethod": "bankTransfer",
"currency": "php",
"transactionReference": "6473fccd-5dea-48d6-ada8-2e55ac61d21e1"
},
"applicant": {
"title": "Mr",
"firstName": "Jorge",
"lastName": "Lee",
"email": "Jorge.Lee@gmail.com",
"id": {
"personal": {
"expiryDate": "2021-01-01T00:00:00.000Z",
"number": "1231"
},
"passport": {
"expiryDate": "2021-01-01T00:00:00.000Z",
"number": "1231"
}
},
"phoneNumber": {
"mobile": {
"e123": "+63 927 236 3233"
},
"home": {
"e123": "+63 927 236 3233"
}
},
"dateOfBirth": "2000-01-01T00:00:00.000Z",
"gender": "Male",
"address": {
"home": {
"block": "Block 1",
"street": "Street 1",
"building": "Building 1",
"district": "District 1",
"estate": "Rich Estate",
"flat": "40",
"floor": "4th",
"postCode": "1234",
"city": "City 1",
"province": "Metro Manila",
"country": "Philppines"
},
"work": {
"block": "Block 1",
"street": "Street 1",
"building": "Building 1",
"district": "District 1",
"estate": "Rich Estate",
"flat": "40",
"floor": "4th",
"postCode": "1234",
"city": "City 1",
"province": "Metro Manila",
"country": "Philppines"
},
"postal": {
"block": "Block 1",
"street": "Street 1",
"building": "Building 1",
"district": "District 1",
"estate": "Rich Estate",
"flat": "40",
"floor": "4th",
"postCode": "1234",
"city": "City 1",
"province": "Metro Manila",
"country": "Philppines"
},
"billing": {
"block": "Block 1",
"street": "Street 1",
"building": "Building 1",
"district": "District 1",
"estate": "Rich Estate",
"flat": "40",
"floor": "4th",
"postCode": "1234",
"city": "City 1",
"province": "Metro Manila",
"country": "Philppines"
}
}
},
"insured": [
{
"title": "Mr",
"firstName": "Jorge",
"lastName": "Lee",
"email": "Jorge.Lee@gmail.com",
"id": {
"personal": {
"expiryDate": "2021-01-01T00:00:00.000Z",
"number": "1231"
},
"passport": {
"expiryDate": "2021-01-01T00:00:00.000Z",
"number": "1231"
}
},
"phoneNumber": {
"mobile": {
"e123": "+63 927 236 3233"
},
"home": {
"e123": "+63 927 236 3233"
}
},
"dateOfBirth": "2000-01-01T00:00:00.000Z",
"gender": "Male",
"address": {
"home": {
"block": "Block 1",
"street": "Street 1",
"building": "Building 1",
"district": "District 1",
"estate": "Rich Estate",
"flat": "40",
"floor": "4th",
"postCode": "1234",
"city": "City 1",
"province": "Metro Manila",
"country": "Philppines"
},
"work": {
"block": "Block 1",
"street": "Street 1",
"building": "Building 1",
"district": "District 1",
"estate": "Rich Estate",
"flat": "40",
"floor": "4th",
"postCode": "1234",
"city": "City 1",
"province": "Metro Manila",
"country": "Philppines"
},
"postal": {
"block": "Block 1",
"street": "Street 1",
"building": "Building 1",
"district": "District 1",
"estate": "Rich Estate",
"flat": "40",
"floor": "4th",
"postCode": "1234",
"city": "City 1",
"province": "Metro Manila",
"country": "Philppines"
},
"billing": {
"block": "Block 1",
"street": "Street 1",
"building": "Building 1",
"district": "District 1",
"estate": "Rich Estate",
"flat": "40",
"floor": "4th",
"postCode": "1234",
"city": "City 1",
"province": "Metro Manila",
"country": "Philppines"
}
},
"relationship": {
"toInsured": "self"
}
}
]
}Schema
{
"type": "object",
"properties": {
"referenceId": {
"type": "string",
"description": "Unique Id for the client's reference."
},
"carrierId": {
"type": "string",
"description": "Carrier name."
},
"policyDetail": {
"type": "object",
"properties": {
"productId": {
"type": "string",
"description": "Product id."
},
"effectiveDate": {
"type": "string",
"description": "Date that this agreement is effective from."
},
"expiryDate": {
"type": "string",
"description": "Date that this agreement expires."
}
},
"required": [
"productId",
"effectiveDate",
"expiryDate"
],
"description": "Details of the policy."
},
"payment": {
"type": "object",
"properties": {
"premiumPaid": {
"type": "string",
"description": "Amount paid for premium."
},
"paymentMethod": {
"type": "string",
"description": "Method by which the payment is made."
},
"currency": {
"type": "string",
"description": "Currency of the amount."
},
"transactionReference": {
"type": "string",
"description": "Reference for payment transaction."
}
},
"required": [
"premiumPaid",
"paymentMethod",
"currency"
],
"description": "Details of payment."
},
"applicant": {
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "Title type for this person."
},
"firstName": {
"type": "string",
"description": "First Name for this person."
},
"lastName": {
"type": "string",
"description": "Last Name for this person."
},
"email": {
"type": "string",
"description": "Email for this person."
},
"id": {
"type": "object",
"properties": {
"personal": {
"type": "object",
"properties": {
"expiryDate": {
"type": "string",
"description": "Expriy Date of this id."
},
"number": {
"type": "string",
"description": "Value for this id."
}
},
"required": [
"number"
]
},
"passport": {
"type": "object",
"properties": {
"expiryDate": {
"type": "string",
"description": "Expriy Date of this id."
},
"number": {
"type": "string",
"description": "Value for this id."
}
},
"required": [
"number"
]
}
},
"required": [
"personal"
],
"description": "Identification Documents for this person"
},
"phoneNumber": {
"type": "object",
"properties": {
"mobile": {
"type": "object",
"properties": {
"e123": {
"type": "string"
}
},
"required": [
"e123"
]
},
"home": {
"type": "object",
"properties": {
"e123": {
"type": "string"
}
},
"required": [
"e123"
]
}
},
"required": [
"mobile"
],
"description": "Contact details."
},
"dateOfBirth": {
"type": "string",
"description": "Date of birth."
},
"gender": {
"type": "string",
"description": "Gender for this person."
},
"address": {
"type": "object",
"properties": {
"home": {
"type": "object",
"properties": {
"block": {
"type": "string",
"description": "Block name."
},
"street": {
"type": "string",
"description": "Street name."
},
"building": {
"type": "string",
"description": "Building name."
},
"district": {
"type": "string",
"description": "Area of the country or city."
},
"estate": {
"type": "string",
"description": "Estate name."
},
"flat": {
"type": "string",
"description": "Unit or Room."
},
"floor": {
"type": "string",
"description": "Floor number."
},
"postCode": {
"type": "string",
"description": "Postal Code."
},
"city": {
"type": "string",
"description": "Name of city."
},
"province": {
"type": "string",
"description": "Name of province."
},
"country": {
"type": "string",
"description": "Name of country."
}
},
"required": [
"postCode",
"city",
"province",
"country"
]
},
"work": {
"type": "object",
"properties": {
"block": {
"type": "string",
"description": "Block name."
},
"street": {
"type": "string",
"description": "Street name."
},
"building": {
"type": "string",
"description": "Building name."
},
"district": {
"type": "string",
"description": "Area of the country or city."
},
"estate": {
"type": "string",
"description": "Estate name."
},
"flat": {
"type": "string",
"description": "Unit or Room."
},
"floor": {
"type": "string",
"description": "Floor number."
},
"postCode": {
"type": "string",
"description": "Postal Code."
},
"city": {
"type": "string",
"description": "Name of city."
},
"province": {
"type": "string",
"description": "Name of province."
},
"country": {
"type": "string",
"description": "Name of country."
}
},
"required": [
"postCode",
"city",
"province",
"country"
]
},
"postal": {
"type": "object",
"properties": {
"block": {
"type": "string",
"description": "Block name."
},
"street": {
"type": "string",
"description": "Street name."
},
"building": {
"type": "string",
"description": "Building name."
},
"district": {
"type": "string",
"description": "Area of the country or city."
},
"estate": {
"type": "string",
"description": "Estate name."
},
"flat": {
"type": "string",
"description": "Unit or Room."
},
"floor": {
"type": "string",
"description": "Floor number."
},
"postCode": {
"type": "string",
"description": "Postal Code."
},
"city": {
"type": "string",
"description": "Name of city."
},
"province": {
"type": "string",
"description": "Name of province."
},
"country": {
"type": "string",
"description": "Name of country."
}
},
"required": [
"postCode",
"city",
"province",
"country"
]
},
"billing": {
"type": "object",
"properties": {
"block": {
"type": "string",
"description": "Block name."
},
"street": {
"type": "string",
"description": "Street name."
},
"building": {
"type": "string",
"description": "Building name."
},
"district": {
"type": "string",
"description": "Area of the country or city."
},
"estate": {
"type": "string",
"description": "Estate name."
},
"flat": {
"type": "string",
"description": "Unit or Room."
},
"floor": {
"type": "string",
"description": "Floor number."
},
"postCode": {
"type": "string",
"description": "Postal Code."
},
"city": {
"type": "string",
"description": "Name of city."
},
"province": {
"type": "string",
"description": "Name of province."
},
"country": {
"type": "string",
"description": "Name of country."
}
},
"required": [
"postCode",
"city",
"province",
"country"
]
}
},
"required": [
"home"
],
"description": "Address of the person (Applicant, Insured, Beneficiary). Flat, Floor, Block, Building, Street, District, Estate forms address lines and might be required for some carriers,"
}
},
"required": [
"firstName",
"lastName",
"phoneNumber",
"dateOfBirth"
],
"description": "The applicant aka policy holder/contract holder."
},
"insured": {
"type": "array",
"items": {
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "Title type for this person."
},
"firstName": {
"type": "string",
"description": "First Name for this person."
},
"lastName": {
"type": "string",
"description": "Last Name for this person."
},
"email": {
"type": "string",
"description": "Email for this person."
},
"id": {
"type": "object",
"properties": {
"personal": {
"type": "object",
"properties": {
"expiryDate": {
"type": "string",
"description": "Expriy Date of this id."
},
"number": {
"type": "string",
"description": "Value for this id."
}
},
"required": [
"number"
]
},
"passport": {
"type": "object",
"properties": {
"expiryDate": {
"type": "string",
"description": "Expriy Date of this id."
},
"number": {
"type": "string",
"description": "Value for this id."
}
},
"required": [
"number"
]
}
},
"required": [
"personal"
],
"description": "Identification Documents for this person"
},
"phoneNumber": {
"type": "object",
"properties": {
"mobile": {
"type": "object",
"properties": {
"e123": {
"type": "string"
}
},
"required": [
"e123"
]
},
"home": {
"type": "object",
"properties": {
"e123": {
"type": "string"
}
},
"required": [
"e123"
]
}
},
"required": [
"mobile"
],
"description": "Contact details."
},
"dateOfBirth": {
"type": "string",
"description": "Date of birth."
},
"gender": {
"type": "string",
"description": "Gender for this person."
},
"address": {
"type": "object",
"properties": {
"home": {
"type": "object",
"properties": {
"block": {
"type": "string",
"description": "Block name."
},
"street": {
"type": "string",
"description": "Street name."
},
"building": {
"type": "string",
"description": "Building name."
},
"district": {
"type": "string",
"description": "Area of the country or city."
},
"estate": {
"type": "string",
"description": "Estate name."
},
"flat": {
"type": "string",
"description": "Unit or Room."
},
"floor": {
"type": "string",
"description": "Floor number."
},
"postCode": {
"type": "string",
"description": "Postal Code."
},
"city": {
"type": "string",
"description": "Name of city."
},
"province": {
"type": "string",
"description": "Name of province."
},
"country": {
"type": "string",
"description": "Name of country."
}
},
"required": [
"postCode",
"city",
"province",
"country"
]
},
"work": {
"type": "object",
"properties": {
"block": {
"type": "string",
"description": "Block name."
},
"street": {
"type": "string",
"description": "Street name."
},
"building": {
"type": "string",
"description": "Building name."
},
"district": {
"type": "string",
"description": "Area of the country or city."
},
"estate": {
"type": "string",
"description": "Estate name."
},
"flat": {
"type": "string",
"description": "Unit or Room."
},
"floor": {
"type": "string",
"description": "Floor number."
},
"postCode": {
"type": "string",
"description": "Postal Code."
},
"city": {
"type": "string",
"description": "Name of city."
},
"province": {
"type": "string",
"description": "Name of province."
},
"country": {
"type": "string",
"description": "Name of country."
}
},
"required": [
"postCode",
"city",
"province",
"country"
]
},
"postal": {
"type": "object",
"properties": {
"block": {
"type": "string",
"description": "Block name."
},
"street": {
"type": "string",
"description": "Street name."
},
"building": {
"type": "string",
"description": "Building name."
},
"district": {
"type": "string",
"description": "Area of the country or city."
},
"estate": {
"type": "string",
"description": "Estate name."
},
"flat": {
"type": "string",
"description": "Unit or Room."
},
"floor": {
"type": "string",
"description": "Floor number."
},
"postCode": {
"type": "string",
"description": "Postal Code."
},
"city": {
"type": "string",
"description": "Name of city."
},
"province": {
"type": "string",
"description": "Name of province."
},
"country": {
"type": "string",
"description": "Name of country."
}
},
"required": [
"postCode",
"city",
"province",
"country"
]
},
"billing": {
"type": "object",
"properties": {
"block": {
"type": "string",
"description": "Block name."
},
"street": {
"type": "string",
"description": "Street name."
},
"building": {
"type": "string",
"description": "Building name."
},
"district": {
"type": "string",
"description": "Area of the country or city."
},
"estate": {
"type": "string",
"description": "Estate name."
},
"flat": {
"type": "string",
"description": "Unit or Room."
},
"floor": {
"type": "string",
"description": "Floor number."
},
"postCode": {
"type": "string",
"description": "Postal Code."
},
"city": {
"type": "string",
"description": "Name of city."
},
"province": {
"type": "string",
"description": "Name of province."
},
"country": {
"type": "string",
"description": "Name of country."
}
},
"required": [
"postCode",
"city",
"province",
"country"
]
}
},
"required": [
"home"
],
"description": "Address of the person (Applicant, Insured, Beneficiary). Flat, Floor, Block, Building, Street, District, Estate forms address lines and might be required for some carriers,"
},
"relationship": {
"type": "object",
"properties": {
"toInsured": {
"type": "string"
}
},
"required": [
"toInsured"
]
}
},
"required": [
"firstName",
"lastName",
"phoneNumber",
"dateOfBirth",
"relationship"
]
},
"description": "List of insured entities."
}
},
"required": [
"referenceId",
"carrierId",
"policyDetail",
"applicant",
"insured"
],
"$schema": "http://json-schema.org/draft-04/schema#"
}Response
200Headers
content-type: application/json; charset=utf-8
content-length: 30
x-marketplace-request-id: c13cb6c6-a11c-4513-bf9a-3aa2a59457d9
x-marketplace-request-timestamp: 2017-08-13T22:30:26.000ZBody
{
"data": {
"referenceId": "6473fccd-5dea-48d6-ada8-2e55ac61d21e"
}
}Schema
{
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"referenceId": {
"type": "string",
"description": "This referenceId is a unique ID passed in the request body."
}
},
"required": [
"referenceId"
]
}
},
"$schema": "http://json-schema.org/draft-04/schema#"
}Response
400Headers
content-type: application/json; charset=utf-8
content-length: 30
x-marketplace-request-id: c13cb6c6-a11c-4513-bf9a-3aa2a59457d9
x-marketplace-request-timestamp: 2017-08-13T22:30:26.000ZBody
{
"code": "EXXX",
"message": "Error details here."
}Schema
{
"type": "object",
"properties": {
"code": {
"type": "string",
"description": "Application error code."
},
"message": {
"type": "string",
"description": "Application error message"
}
},
"required": [
"code",
"message"
],
"$schema": "http://json-schema.org/draft-04/schema#"
}Response
401Headers
content-type: application/json; charset=utf-8
content-length: 30
x-marketplace-request-id: c13cb6c6-a11c-4513-bf9a-3aa2a59457d9
x-marketplace-request-timestamp: 2017-08-13T22:30:26.000ZBody
{
"code": "EXXX",
"message": "Error details here."
}Schema
{
"type": "object",
"properties": {
"code": {
"type": "string",
"description": "Application error code."
},
"message": {
"type": "string",
"description": "Application error message"
}
},
"required": [
"code",
"message"
],
"$schema": "http://json-schema.org/draft-04/schema#"
}Response
500Headers
content-type: application/json; charset=utf-8
content-length: 30
x-marketplace-request-id: c13cb6c6-a11c-4513-bf9a-3aa2a59457d9
x-marketplace-request-timestamp: 2017-08-13T22:30:26.000ZBody
{
"code": "EXXX",
"message": "Error details here."
}Schema
{
"type": "object",
"properties": {
"code": {
"type": "string",
"description": "Application error code."
},
"message": {
"type": "string",
"description": "Application error message"
}
},
"required": [
"code",
"message"
],
"$schema": "http://json-schema.org/draft-04/schema#"
}Get Case ¶
Get case by referenceId.
Get CaseGET/api/v1/case/{referenceId}
Example URI
GET ubx.dev.yellow.coherent.global/api/v1/case/6473fccd-5dea-48d6-ada8-2e55ac61d21e
URI Parameters
- referenceId
string(required) Example: 6473fccd-5dea-48d6-ada8-2e55ac61d21eUnique Id used on create case.
Request
Headers
accept: application/json
content-type: application/json
Authorizer: TokenResponse
200Headers
content-type: application/json; charset=utf-8
content-length: 30
x-marketplace-request-id: c13cb6c6-a11c-4513-bf9a-3aa2a59457d9
x-marketplace-request-timestamp: 2017-08-13T22:30:26.000ZBody
{
"data": {
"status": "ISSUED",
"firstName": "Jorge",
"lastName": "Lee",
"carrier": "chubbph",
"channel": "ubp",
"effectiveDate": "2021-01-20T00:00:00.000000Z",
"expiryDate": "2022-01-20T00:00:00.000000Z",
"created": "2021-02-03T04:05:05.302936Z",
"updated": "2021-02-03T04:05:17.197677Z",
"policyNumber": "UNIPH0002232583",
"referenceId": "f81761e1-2498-4546-948e-01d40443fc27",
"productName": "UBXPHEMBCRED00000001"
}
}Schema
{
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"status": {
"type": "string",
"description": "This is the current status of the case."
},
"firstName": {
"type": "string",
"description": "First Name for this person."
},
"lastName": {
"type": "string",
"description": "Last Name for this person."
},
"carrier": {
"type": "string",
"description": "Carrier name."
},
"channel": {
"type": "string",
"description": "Channel name."
},
"effectiveDate": {
"type": "string",
"description": "Date that this agreement is effective from."
},
"expiryDate": {
"type": "string",
"description": "Date that this agreement expires."
},
"created": {
"type": "string",
"description": "Date that this case created."
},
"updated": {
"type": "string",
"description": "Date that this case updated."
},
"policyNumber": {
"type": "string",
"description": "This policyNumber is issued by the carrier, not the marketplace platform."
},
"referenceId": {
"type": "string",
"description": "This referenceId is a unique ID passed in the request body."
},
"productName": {
"type": "string",
"description": "This is the product name."
}
},
"required": [
"status",
"firstName",
"lastName",
"carrier",
"channel",
"effectiveDate",
"expiryDate",
"created",
"updated",
"policyNumber",
"referenceId",
"productName"
]
}
},
"$schema": "http://json-schema.org/draft-04/schema#"
}Response
400Headers
content-type: application/json; charset=utf-8
content-length: 30
x-marketplace-request-id: c13cb6c6-a11c-4513-bf9a-3aa2a59457d9
x-marketplace-request-timestamp: 2017-08-13T22:30:26.000ZBody
{
"code": "EXXX",
"message": "Error details here."
}Schema
{
"type": "object",
"properties": {
"code": {
"type": "string",
"description": "Application error code."
},
"message": {
"type": "string",
"description": "Application error message"
}
},
"required": [
"code",
"message"
],
"$schema": "http://json-schema.org/draft-04/schema#"
}Response
401Headers
content-type: application/json; charset=utf-8
content-length: 30
x-marketplace-request-id: c13cb6c6-a11c-4513-bf9a-3aa2a59457d9
x-marketplace-request-timestamp: 2017-08-13T22:30:26.000ZBody
{
"code": "EXXX",
"message": "Error details here."
}Schema
{
"type": "object",
"properties": {
"code": {
"type": "string",
"description": "Application error code."
},
"message": {
"type": "string",
"description": "Application error message"
}
},
"required": [
"code",
"message"
],
"$schema": "http://json-schema.org/draft-04/schema#"
}Response
500Headers
content-type: application/json; charset=utf-8
content-length: 30
x-marketplace-request-id: c13cb6c6-a11c-4513-bf9a-3aa2a59457d9
x-marketplace-request-timestamp: 2017-08-13T22:30:26.000ZBody
{
"code": "EXXX",
"message": "Error details here."
}Schema
{
"type": "object",
"properties": {
"code": {
"type": "string",
"description": "Application error code."
},
"message": {
"type": "string",
"description": "Application error message"
}
},
"required": [
"code",
"message"
],
"$schema": "http://json-schema.org/draft-04/schema#"
}Check Status ¶
Get case status by referenceId.
Case Statuses:
-
OPENED- Case is successfully created but not yet submitted. -
ISSUED- Case is submitted to the carrier and a policy is issued. -
DECLINED- Policy issue declined due to errors. -
CANCELLED- Corresponding policy for the case is cancelled
Check StatusGET/api/v1/case/{referenceId}/status
Example URI
GET ubx.dev.yellow.coherent.global/api/v1/case/6473fccd-5dea-48d6-ada8-2e55ac61d21e/status
URI Parameters
- referenceId
string(required) Example: 6473fccd-5dea-48d6-ada8-2e55ac61d21eUnique Id used on create case.
Request
Headers
accept: application/json
content-type: application/json
Authorizer: TokenResponse
200Headers
content-type: application/json; charset=utf-8
content-length: 30
x-marketplace-request-id: c13cb6c6-a11c-4513-bf9a-3aa2a59457d9
x-marketplace-request-timestamp: 2017-08-13T22:30:26.000ZBody
{
"data": {
"status": "ISSUED"
}
}Schema
{
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"status": {
"type": "string",
"description": "This is the current status of the case."
}
},
"required": [
"status"
]
}
},
"$schema": "http://json-schema.org/draft-04/schema#"
}Response
400Headers
content-type: application/json; charset=utf-8
content-length: 30
x-marketplace-request-id: c13cb6c6-a11c-4513-bf9a-3aa2a59457d9
x-marketplace-request-timestamp: 2017-08-13T22:30:26.000ZBody
{
"code": "EXXX",
"message": "Error details here."
}Schema
{
"type": "object",
"properties": {
"code": {
"type": "string",
"description": "Application error code."
},
"message": {
"type": "string",
"description": "Application error message"
}
},
"required": [
"code",
"message"
],
"$schema": "http://json-schema.org/draft-04/schema#"
}Response
401Headers
content-type: application/json; charset=utf-8
content-length: 30
x-marketplace-request-id: c13cb6c6-a11c-4513-bf9a-3aa2a59457d9
x-marketplace-request-timestamp: 2017-08-13T22:30:26.000ZBody
{
"code": "EXXX",
"message": "Error details here."
}Schema
{
"type": "object",
"properties": {
"code": {
"type": "string",
"description": "Application error code."
},
"message": {
"type": "string",
"description": "Application error message"
}
},
"required": [
"code",
"message"
],
"$schema": "http://json-schema.org/draft-04/schema#"
}Response
500Headers
content-type: application/json; charset=utf-8
content-length: 30
x-marketplace-request-id: c13cb6c6-a11c-4513-bf9a-3aa2a59457d9
x-marketplace-request-timestamp: 2017-08-13T22:30:26.000ZBody
{
"code": "EXXX",
"message": "Error details here."
}Schema
{
"type": "object",
"properties": {
"code": {
"type": "string",
"description": "Application error code."
},
"message": {
"type": "string",
"description": "Application error message"
}
},
"required": [
"code",
"message"
],
"$schema": "http://json-schema.org/draft-04/schema#"
}Reference ¶
Cancellation details and other information.
ReferenceGET/api/v1/reference/{carrierId}/{category}
Example URI
GET ubx.dev.yellow.coherent.global/api/v1/reference/chubb/cancellation_reason
URI Parameters
- carrierId
string(required) Example: chubbCarrier name.
- category
string(required) Example: cancellation_reasonData to be fetch.
Request
Headers
accept: application/json
content-type: application/json
Authorizer: TokenResponse
200Headers
content-type: application/json; charset=utf-8
content-length: 30
x-marketplace-request-id: c13cb6c6-a11c-4513-bf9a-3aa2a59457d9
x-marketplace-request-timestamp: 2017-08-13T22:30:26.000ZBody
{
"data": {
"cancellationReasons": [
{
"display": "Driver cancelled.",
"value": "DRIVER_CANCELLED"
},
{
"display": "Insufficient funds.",
"value": "INSUFFICIENT_FUNDS"
},
{
"display": "Over age.",
"value": "OVER_AGE"
},
{
"display": "Driver dropoff.",
"value": "DRIVER_DROPOFF"
},
{
"display": "Policy replaced.",
"value": "POLICY_REPLACED"
}
]
}
}Response
400Headers
content-type: application/json; charset=utf-8
content-length: 30
x-marketplace-request-id: c13cb6c6-a11c-4513-bf9a-3aa2a59457d9
x-marketplace-request-timestamp: 2017-08-13T22:30:26.000ZBody
{
"code": "EXXX",
"message": "Error details here."
}Schema
{
"type": "object",
"properties": {
"code": {
"type": "string",
"description": "Application error code."
},
"message": {
"type": "string",
"description": "Application error message"
}
},
"required": [
"code",
"message"
],
"$schema": "http://json-schema.org/draft-04/schema#"
}Response
401Headers
content-type: application/json; charset=utf-8
content-length: 30
x-marketplace-request-id: c13cb6c6-a11c-4513-bf9a-3aa2a59457d9
x-marketplace-request-timestamp: 2017-08-13T22:30:26.000ZBody
{
"code": "EXXX",
"message": "Error details here."
}Schema
{
"type": "object",
"properties": {
"code": {
"type": "string",
"description": "Application error code."
},
"message": {
"type": "string",
"description": "Application error message"
}
},
"required": [
"code",
"message"
],
"$schema": "http://json-schema.org/draft-04/schema#"
}Response
500Headers
content-type: application/json; charset=utf-8
content-length: 30
x-marketplace-request-id: c13cb6c6-a11c-4513-bf9a-3aa2a59457d9
x-marketplace-request-timestamp: 2017-08-13T22:30:26.000ZBody
{
"code": "EXXX",
"message": "Error details here."
}Schema
{
"type": "object",
"properties": {
"code": {
"type": "string",
"description": "Application error code."
},
"message": {
"type": "string",
"description": "Application error message"
}
},
"required": [
"code",
"message"
],
"$schema": "http://json-schema.org/draft-04/schema#"
}API Errors ¶
This section identifies the different types of errors that Marketplace API operations can return.
400 Bad Request
| Code | Message |
|---|---|
| E400.01 | Basic Validation Error. |
| E400.02 | Duplicate policy. |
| E400.03 | Customer age ineligible. |
| E400.04 | Duplicate accounts. |
| E400.05 | Maximum sum insured exceeded. |
| E400.06 | Maximum number of policies exceeded. |
| E400.07 | Premium mismatch. |
| E400.08 | Incorrect product specific data. |
| E400.09 | Policy already cancelled. |
| E400.10 | ReferenceId is not unique. |
| E400.11 | Invalid referenceId. |
| E400.12 | Can only submit a case when the status is OPENED. |
| E400.99 | General carrier system error. |
401 Unauthorized
| Code | Message |
|---|---|
| E401.01 | Invalid token signature. |
| E401.02 | Missing token. |
| E401.03 | Authorizer must be present in header. |
| E401.04 | No group claim available. |
| E401.05 | Carrier Access Denied. |
500 Internal Server Error
| Code | Message |
|---|---|
| E500.01 | Internal server error. |
| E500.02 | Carrier server error. |