Insurance
Summary
This API returns customer’s source accounts eligible for insurance booking.
Want to try this API out on our Playground?
Go play now| post /v1/insurance/bookings | Book Customer Insurance |
| get /v1/insurance/bookings/sourceAccounts | Retrieve Eligible Source Account |
| post /v1/insurance/bookings/withOfflinePayments | Book Customer Insurance With Offline Payment |
| get /partner/v1/insurance/customers/risks | Retrieve Customer Insurance Profile details |
Book Customer Insurance
post
/v1/insurance/bookings
This API is used to book insurance for the customer.
SwaggerHeader Parameters
Authorization
string
required
The most recent Authorization token. This will have the format Bearer + {space} + {accessToken}. Example: Bearer KGNsaWVudF9pZDpjbGllbnRfc2VjcmV0KQ==.
uuid
string
required
128 bit random UUID generated uniquely for every request.
Accept
string
required
Content-Type that are acceptable for the response.
client_id
string
required
Client ID generated during application registration.
Content-Type
string
required
application/json
clientDetails
string
Optional
This field is used to capture device,browser and network information. Refer the developer portal for more information.These are the fields which will be passed as part of the header devicePrint,deviceTokenCookie,userIpAddress,userAgent,hardwareId,simId,deviceModel,deviceName,deviceOsName,deviceOsVersion,multitaskingSupportFlag,languageSupport,wifiMacAddress,cellTowerId,locationAreaCode,rsaApplicationKey,wapClientId,mobileCarrierCode,mobileCountryCode,osId,geoLongitude,geoLatitude,geoHorizontalAccuracy,geoAltitude,geoAltitudeAccuracy,geoSpeed,geoTimestamp,geoStatus,basicServiceSetId,signalStrength,wifiChannel,serviceSetId
Body Parameters
CustomerInsuranceBookingRequest
required
CustomerInsuranceBookingRequest
Show schema
×
object: CustomerInsuranceBookingRequest
{
"properties": {
"policyDetails": {
"properties": {
"insuranceProductCode": {
"description": "Insurance product code",
"type": "string",
"example": "PR001- PAGOS PROTEGIDOS BASICO"
},
"insuranceProductCurrencyCode": {
"description": "Currency code of the insurance in ISO 4217 format.",
"type": "string",
"example": "SGD"
},
"insurancePolicyNumber": {
"description": "Policy number of the insurance product.",
"type": "string",
"example": "83748374389"
},
"insurancePolicyStatus": {
"description": "Status of the insurance policy. This is a reference data field. Please use \/utilities\/referenceData\/{insurancePolicyStatus} resource to get valid values of this field with descriptions.",
"type": "string",
"example": "CONFIRMED"
},
"insuranceSumAssuredAmount": {
"description": "It is the guaranteed amount the policy holder will receive",
"type": "number",
"format": "double",
"example": 25000.12
},
"insurancePremiumPaymentFrequency": {
"description": "Frequency of premium payment. This is a reference data field. Please use \/utilities\/referenceData\/{insurancePremiumPaymentFrequency} resource to get valid values of this field with descriptions.",
"type": "string",
"example": "MONTHLY"
},
"policyTermType": {
"description": "Benefit Tenure in months or years. This is a reference data field. Please use \/utilities\/referenceData\/{policyTermType} resource to get valid values of this field with descriptions.",
"type": "string",
"example": "MONTHS"
},
"policyTerm": {
"description": "The period of coverage provided by an insurance policy.",
"type": "number",
"format": "integer",
"example": 120
},
"premiumPaymentTermType": {
"description": "Premium Tenure in months or years. This is a reference data field. Please use \/utilities\/referenceData\/{premiumPaymentTermType} resource to get valid values of this field with descriptions.",
"type": "string",
"example": "MONTHS"
},
"premiumPaymentTerm": {
"description": "It is the total number of months for the policy holder to pay the premium.",
"type": "number",
"format": "integer",
"example": 180
},
"policyBillingMode": {
"description": "Indicates whether billing will be done by Citi or by external party or by both. This is a reference data field. Please use \/utilities\/referenceData\/{policyBillingMode} resource to get valid values of this field with descriptions.",
"type": "string",
"example": "INTERNAL"
},
"applicationDate": {
"description": "Date on which application is created in ISO 8601 date format YYYY-MM-DD",
"type": "string",
"format": "date",
"example": "2018-10-01'"
},
"insurancePolicyEffectiveDate": {
"description": "Date at which an insurance policy goes into force.",
"type": "string",
"format": "date",
"example": "2018-11-01"
},
"basePremiumAmount": {
"description": "It is the specified amount stipulated by the insurance company, which the insured individual should periodically pay to maintain the actual coverage of insurance.",
"type": "number",
"format": "double",
"example": 1000.21
},
"addOnPremiumAmount": {
"description": "Add-on premium amount",
"type": "number",
"format": "double",
"example": 100.52
},
"totalPremiumAmount": {
"description": "It is the sum of base premium amount and add on premium amount.",
"type": "number",
"format": "double",
"example": 1110.73
},
"policyMaturityDate": {
"description": "Date when policy will be matured",
"type": "string",
"format": "date",
"example": "2028-11-01'"
},
"legalAgreementFlag": {
"description": "This flag is used to indicate whether the customer is agreeing on the legal agreement.",
"type": "string",
"format": "boolean",
"example": true
},
"firstPremiumDueDate": {
"description": "Date on which first premium is due.",
"type": "string",
"format": "date",
"example": "2018-10-05'"
}
},
"required": [
"insuranceProductCode",
"insuranceProductCurrencyCode",
"insurancePolicyNumber",
"insurancePolicyStatus",
"insuranceSumAssuredAmount",
"insurancePremiumPaymentFrequency",
"policyTermType",
"policyTerm",
"premiumPaymentTermType",
"premiumPaymentTerm",
"policyBillingMode",
"applicationDate",
"insurancePolicyEffectiveDate",
"basePremiumAmount",
"totalPremiumAmount",
"policyMaturityDate"
]
},
"offerDetails": {
"properties": {
"waveId": {
"description": "Unique identifier for the promotion under specific campaign being offered to the channel",
"type": "string",
"example": 987654321
},
"campaignId": {
"description": "Unique identifier for a specific campaign being offered to the channel",
"type": "string",
"example": 123456789
},
"offerId": {
"description": "Unique offer ID associated with the offer",
"type": "string",
"example": 111000125
}
},
"required": [
"campaignId"
]
},
"riderDetails": {
"type": "array",
"items": {
"properties": {
"riderCode": {
"description": "It is the unique code associated with the insurance rider(Insurance rider is an optional add-on to an insurance policy. It is a provision of an insurance policy that adds to or amends the coverage or terms.)",
"type": "string",
"example": "TP1"
},
"riderSumAssuredAmount": {
"description": "Sum assured amount for the rider.",
"type": "number",
"format": "double",
"example": 25000.11
},
"addOnPremiumAmount": {
"description": "Add-on premium for the rider.",
"type": "number",
"format": "double"
},
"riderTermType": {
"description": "Rider premium payment tenure type. This is a reference data field. Please use \/utilities\/referenceData\/{riderTermType} resource to get valid values of this field with descriptions.",
"type": "string",
"example": "MONTHS"
},
"riderTerm": {
"description": "Rider premium payment tenure",
"type": "number",
"format": "integer",
"example": 60
},
"riderEffectiveDate": {
"description": "Rider Effective Date",
"type": "string",
"format": "date",
"example": 1546214400000
}
},
"required": [
"riderCode",
"riderSumAssuredAmount",
"addOnPremiumAmount",
"riderTermType",
"riderTerm",
"riderEffectiveDate"
]
}
},
"applicant": {
"type": "array",
"items": {
"properties": {
"name": {
"properties": {
"salutation": {
"description": "This field is to indicate the salutation of the applicant.This is a reference data field. Please use \/v1\/apac\/utilities\/referenceData\/{salutation} resource to get possible value of this field with description.",
"type": "string",
"example": "MR."
},
"givenName": {
"description": "Given\/first name of the applicant",
"type": "string",
"example": "Javier"
},
"middleName": {
"description": "Middle name of the applicant",
"type": "string",
"example": "Perez"
},
"surname": {
"description": "Surname\/last name of the applicant.",
"type": "string",
"example": "de Cuellar"
}
},
"required": [
"salutation",
"givenName",
"surname"
]
},
"identificationDocumentDetails": {
"type": "array",
"items": {
"properties": {
"idType": {
"description": "Type of Identification document. This is a reference data field. Please use \/v1\/utilities\/referenceData\/{idType} resource to get valid values of this field with descriptions",
"type": "string",
"example": "PASSPORT"
},
"idNumber": {
"description": "Unique identifier of identification document.",
"type": "string",
"example": "Passport- 443431, CIN- 123123123"
}
},
"required": [
"idType",
"idNumber"
]
}
},
"demographics": {
"properties": {
"gender": {
"description": "Gender of the Insured. Please use \/v1\/apac\/utilities\/referenceData\/{gender} resource to get valid value of this field with description.",
"type": "string",
"example": "MALE"
},
"dateOfBirth": {
"description": "Date of Birth of the Insured in ISO 8601 date format YYYY-MM-DD",
"type": "string",
"format": "date",
"example": "1980-01-01"
},
"maritalStatus": {
"description": "Applicants marital status. Please use \/v1\/apac\/utilities\/referenceData\/{maritalStatus} resource to get valid value of this field with description. ",
"type": "string",
"example": "SINGLE"
},
"nationality": {
"description": "Applicants nationality. Please use \/v1\/apac\/utilities\/referenceData\/{nationality} resource to get valid value of this field with description.",
"type": "string",
"example": "SG"
}
},
"required": [
"dateOfBirth"
]
},
"employmentDetails": {
"properties": {
"occupationCode": {
"description": "Occupation code. Please use \/utilities\/referenceData\/{occupationCode} resource to get valid values of this field with descriptions.",
"type": "string",
"example": "ACCOUNTANT"
},
"businessNature": {
"description": "Occupation category which represents the business nature it belongs to. This is a reference data field. Please use \/v1\/utilities\/referenceData\/{businessNature} resource to get valid value of this field with description.",
"type": "string",
"example": "BANKING"
}
}
},
"ownershipType": {
"description": "Indicates whether the insured is also the owner of the policy. This is a reference data field. Please use \/utilities\/referenceData\/{ownershipType} resource to get valid values of this field with descriptions.",
"type": "string",
"example": "OWNER"
},
"additionalData": {
"properties": {
"relationshipWithPrimary": {
"description": "Relationship of the Insured with the owner. This is a reference data field. Please use \/utilities\/referenceData\/{relationshipWithPrimary} resource to get valid values of this field with descriptions.",
"type": "string",
"example": "HUSBAND"
}
},
"required": [
"relationshipWithPrimary"
]
},
"email": {
"type": "array",
"items": {
"properties": {
"emailAddress": {
"description": "Applicants email address",
"type": "string",
"example": "javier@abcd.com"
}
},
"required": [
"emailAddress"
]
}
},
"address": {
"type": "array",
"items": {
"properties": {
"addressLine1": {
"description": "Address line 1",
"type": "string",
"example": "40A Orchard Road"
},
"addressLine2": {
"description": "Address line 2",
"type": "string",
"example": "#99-99 Macdonald House"
},
"addressLine3": {
"description": "Address line 3",
"type": "string",
"example": "Orchard Avenue 2"
},
"addressLine4": {
"description": "Address line 4",
"type": "string",
"example": "Street 65"
},
"cityName": {
"description": "City",
"type": "string",
"example": "Singapore"
},
"state": {
"description": "State. This is a reference data field. Please use \/utilities\/referenceData\/{addressState} resource to get possible values of this field with descriptions.",
"type": "string",
"example": "SINGAPORE"
},
"postalCode": {
"description": "Postal\/ZIP code",
"type": "string",
"example": 520189
},
"countryCode": {
"description": "ISO country code. This is a reference data field. Please use \/utilities\/referenceData\/{country} resource to get possible values of this field with descriptions.",
"type": "string"
}
},
"required": [
"addressLine1",
"postalCode"
]
}
},
"phone": {
"type": "array",
"items": {
"properties": {
"phoneNumber": {
"description": "Applicants phone number",
"type": "string"
},
"phoneCountryCode": {
"description": "Country calling code. This is a reference data field. Please use \/utilities\/referenceData\/{phoneCountryCode} resource to get possible values of this field with descriptions.",
"type": "string",
"example": "65"
},
"areaCode": {
"description": "The area code of phone number",
"type": "string"
},
"extension": {
"description": "Extension of telephone number",
"type": "string"
}
},
"required": [
"phoneNumber",
"phoneCountryCode"
]
}
}
},
"required": [
"name",
"ownershipType"
]
}
},
"initialPaymentDetails": {
"properties": {
"sourceAccountId": {
"description": "The source account identifier of the IPA in encrypted format.Typically, this is not displayed to the customer.",
"type": "string",
"example": "3c344e38756339654972776f663745446e6d4c32486f455a4165374a476858343d"
}
},
"required": [
"sourceAccountId"
]
},
"premiumSourceAccount": {
"properties": {
"sourceAccountId": {
"description": "The source account identifier of the premium account in encrypted format.Typically, this is not displayed to the customer.",
"type": "string",
"example": "1234567896f2b4d4d796c344e387563374a476jfhjd23478377889738343d"
}
},
"required": [
"sourceAccountId"
]
},
"beneficiary": {
"type": "array",
"items": {
"properties": {
"identificationDocumentDetails": {
"type": "array",
"items": {
"properties": {
"idType": {
"description": "Type of Identification document. This is a reference data field. Please use \/v1\/utilities\/referenceData\/{idType} resource to get valid values of this field with descriptions",
"type": "string",
"example": "PASSPORT"
},
"idNumber": {
"description": "Unique identifier of identification document.",
"type": "string",
"example": "Passport- 443431, CIN- 123123123"
}
},
"required": [
"idType",
"idNumber"
]
}
},
"name": {
"properties": {
"salutation": {
"description": "This field is to indicate the salutation of the applicant.This is a reference data field. Please use \/v1\/apac\/utilities\/referenceData\/{salutation} resource to get possible value of this field with description.",
"type": "string",
"example": "MR."
},
"givenName": {
"description": "Given\/first name of the applicant",
"type": "string",
"example": "Javier"
},
"middleName": {
"description": "Middle name of the applicant",
"type": "string",
"example": "Perez"
},
"surname": {
"description": "Surname\/last name of the applicant.",
"type": "string",
"example": "de Cuellar"
}
},
"required": [
"salutation",
"givenName",
"surname"
]
},
"demographics": {
"properties": {
"gender": {
"description": "Gender of the Insured. Please use \/v1\/apac\/utilities\/referenceData\/{gender} resource to get valid value of this field with description.",
"type": "string",
"example": "MALE"
},
"dateOfBirth": {
"description": "Date of Birth of the Insured in ISO 8601 date format YYYY-MM-DD",
"type": "string",
"format": "date",
"example": "1980-01-01"
},
"maritalStatus": {
"description": "Applicants marital status. Please use \/v1\/apac\/utilities\/referenceData\/{maritalStatus} resource to get valid value of this field with description. ",
"type": "string",
"example": "SINGLE"
},
"nationality": {
"description": "Applicants nationality. Please use \/v1\/apac\/utilities\/referenceData\/{nationality} resource to get valid value of this field with description.",
"type": "string",
"example": "SG"
}
},
"required": [
"dateOfBirth"
]
},
"employmentDetails": {
"properties": {
"occupationCode": {
"description": "Occupation code. Please use \/utilities\/referenceData\/{occupationCode} resource to get valid values of this field with descriptions.",
"type": "string",
"example": "ACCOUNTANT"
},
"businessNature": {
"description": "Occupation category which represents the business nature it belongs to. This is a reference data field. Please use \/v1\/utilities\/referenceData\/{businessNature} resource to get valid value of this field with description.",
"type": "string",
"example": "BANKING"
}
}
},
"additionalData": {
"properties": {
"relationshipWithPrimary": {
"description": "Relationship of the Insured with the owner. This is a reference data field. Please use \/utilities\/referenceData\/{relationshipWithPrimary} resource to get valid values of this field with descriptions.",
"type": "string",
"example": "HUSBAND"
}
},
"required": [
"relationshipWithPrimary"
]
},
"insuranceSumAssuredAllocationPercentage": {
"description": "Allocation percentage of sum insured amount",
"type": "number",
"format": "double"
}
},
"required": [
"name",
"insuranceSumAssuredAllocationPercentage"
]
}
},
"questionnaire": {
"type": "array",
"items": {
"properties": {
"questionId": {
"description": "Unique Identifier for the question.",
"type": "string",
"example": 1
},
"answerText": {
"description": "Answers provided by the policy holder",
"type": "string",
"example": "Yes or No"
},
"remarks": {
"description": "Remarks provided to the questions",
"type": "string",
"example": "Health Declartion1"
}
},
"required": [
"questionId",
"answerText"
]
}
}
},
"required": [
"policyDetails",
"applicant"
]
}- cURL
- Ruby
- Python
- PHP
- Java
- Node
- Go
- Swift
Example Request
Example Request
Example Request
Example Request
Example Request
Example Request
Example Request
Example Request
200
Successful operation.
This operation returns no content.
400
| fatal | invalidRequest | Missing or invalid parameters |
| error | insufficientFund | Insufficient fund |
| error | tempServiceSuspensionDueToNaturalCalamity | Temporary service suspension due to natural calamities |
| error | invalidAccountStatus | Account status is invalid |
Definitions
-
type
- Invalid - Request did not confirm to the specification and was unprocessed and rejected. Please fix the value and try again
- enum : error, warn, invalid, fatal
- type : string
-
code
- Error code which qualifies the error
- type : string
-
details
- Human readable explanation specific to the occurrence of the problem
- type : string
-
location
- The name of the field that resulted in the error
- type : string
-
moreInfo
- URI to human readable documentation of the error
- type : object
-
required
- type
- code
Response Schema for post
/v1/insurance/bookings
{
"properties": {
"type": {
"description": "Invalid - Request did not confirm to the specification and was unprocessed and rejected. Please fix the value and try again",
"enum": [
"error",
"warn",
"invalid",
"fatal"
],
"type": "string"
},
"code": {
"description": "Error code which qualifies the error",
"type": "string"
},
"details": {
"description": "Human readable explanation specific to the occurrence of the problem",
"type": "string"
},
"location": {
"description": "The name of the field that resulted in the error",
"type": "string"
},
"moreInfo": {
"description": "URI to human readable documentation of the error",
"type": "object"
}
},
"required": [
"type",
"code"
]
}
401
| error | unAuthorized | Authorization credential is missing or invalid |
Definitions
-
type
- Invalid - Request did not confirm to the specification and was unprocessed and rejected. Please fix the value and try again
- enum : error, warn, invalid, fatal
- type : string
-
code
- Error code which qualifies the error
- type : string
-
details
- Human readable explanation specific to the occurrence of the problem
- type : string
-
location
- The name of the field that resulted in the error
- type : string
-
moreInfo
- URI to human readable documentation of the error
- type : object
-
required
- type
- code
Response Schema for post
/v1/insurance/bookings
{
"properties": {
"type": {
"description": "Invalid - Request did not confirm to the specification and was unprocessed and rejected. Please fix the value and try again",
"enum": [
"error",
"warn",
"invalid",
"fatal"
],
"type": "string"
},
"code": {
"description": "Error code which qualifies the error",
"type": "string"
},
"details": {
"description": "Human readable explanation specific to the occurrence of the problem",
"type": "string"
},
"location": {
"description": "The name of the field that resulted in the error",
"type": "string"
},
"moreInfo": {
"description": "URI to human readable documentation of the error",
"type": "object"
}
},
"required": [
"type",
"code"
]
}
403
| error | accessNotConfigured | Access is not configured for this resource |
| error | mfaRequired | MFA is required |
| error | transactionDenied | Transaction is denied |
Definitions
-
type
- Invalid - Request did not confirm to the specification and was unprocessed and rejected. Please fix the value and try again
- enum : error, warn, invalid, fatal
- type : string
-
code
- Error code which qualifies the error
- type : string
-
details
- Human readable explanation specific to the occurrence of the problem
- type : string
-
location
- The name of the field that resulted in the error
- type : string
-
moreInfo
- URI to human readable documentation of the error
- type : object
-
required
- type
- code
Response Schema for post
/v1/insurance/bookings
{
"properties": {
"type": {
"description": "Invalid - Request did not confirm to the specification and was unprocessed and rejected. Please fix the value and try again",
"enum": [
"error",
"warn",
"invalid",
"fatal"
],
"type": "string"
},
"code": {
"description": "Error code which qualifies the error",
"type": "string"
},
"details": {
"description": "Human readable explanation specific to the occurrence of the problem",
"type": "string"
},
"location": {
"description": "The name of the field that resulted in the error",
"type": "string"
},
"moreInfo": {
"description": "URI to human readable documentation of the error",
"type": "object"
}
},
"required": [
"type",
"code"
]
}
500
| fatal | serverUnavailable | The request failed due to an internal error |
Definitions
-
type
- Invalid - Request did not confirm to the specification and was unprocessed and rejected. Please fix the value and try again
- enum : error, warn, invalid, fatal
- type : string
-
code
- Error code which qualifies the error
- type : string
-
details
- Human readable explanation specific to the occurrence of the problem
- type : string
-
location
- The name of the field that resulted in the error
- type : string
-
moreInfo
- URI to human readable documentation of the error
- type : object
-
required
- type
- code
Response Schema for post
/v1/insurance/bookings
{
"properties": {
"type": {
"description": "Invalid - Request did not confirm to the specification and was unprocessed and rejected. Please fix the value and try again",
"enum": [
"error",
"warn",
"invalid",
"fatal"
],
"type": "string"
},
"code": {
"description": "Error code which qualifies the error",
"type": "string"
},
"details": {
"description": "Human readable explanation specific to the occurrence of the problem",
"type": "string"
},
"location": {
"description": "The name of the field that resulted in the error",
"type": "string"
},
"moreInfo": {
"description": "URI to human readable documentation of the error",
"type": "object"
}
},
"required": [
"type",
"code"
]
}Retrieve Eligible Source Account
get
/v1/insurance/bookings/sourceAccounts
This API returns customer’s source accounts eligible for insurance booking.
Header Parameters
Authorization
string
required
The most recent Authorization token. This will have the format Bearer + {space} + {accessToken}. Example: Bearer KGNsaWVudF9pZDpjbGllbnRfc2VjcmV0KQ==.
uuid
string
required
128 bit random UUID generated uniquely for every request.
Accept
string
required
Content-Type that are acceptable for the response.
client_id
string
required
Client ID generated during application registration.
clientDetails
string
Optional
This field is used to capture device,browser and network information. Refer the developer portal for more information.These are the fields which will be passed as part of the header devicePrint,deviceTokenCookie,userIpAddress,userAgent,hardwareId,simId,deviceModel,deviceName,deviceOsName,deviceOsVersion,multitaskingSupportFlag,languageSupport,wifiMacAddress,cellTowerId,locationAreaCode,rsaApplicationKey,wapClientId,mobileCarrierCode,mobileCountryCode,osId,geoLongitude,geoLatitude,geoHorizontalAccuracy,geoAltitude,geoAltitudeAccuracy,geoSpeed,geoTimestamp,geoStatus,basicServiceSetId,signalStrength,wifiChannel,serviceSetId
- cURL
- Ruby
- Python
- PHP
- Java
- Node
- Go
- Swift
Example Request
Example Request
Example Request
Example Request
Example Request
Example Request
Example Request
Example Request
200
Successful operation.
Definitions
-
sourceAccounts
-
-
sourceAccountId
- The primary identifier for ownership of an account.The source account identifier in encrypted format.
- type : string
-
displaySourceAccountNumber
- A masked account number/last four(4) digits of source account number that can be displayed to the customer
- type : string
-
sourceAccountCurrencyCode
- The currency code of the source account in ISO 4217 format
- type : string
-
accountGroup
- Account Group associated with the source Account. This is a reference data field. Please use /v1/utilities/referenceData/{accountGroup} resource to get valid value of this field with description.
- type : string
-
availableBalance
- The available balance including any pending or in progress deposits and withdrawals
- type : number
- format : double
-
localCurrencyAvailableBalance
- Available balance in local currency. Applicable only if the source account is in foreign currency.
- type : number
- format : double
-
localCurrencyCode
- The currency code for local country in ISO 4217 format. Applicable only if the source account is in foreign currency.
- type : string
-
sourceAccountId
-
-
nextStartIndex
- The start index of the next subset of payees.
- type : string
Example Response for get
/v1/insurance/bookings/sourceAccounts
204
| Type | Code | Details |
| Success | No Content |
Definitions
-
type
- Invalid - Request did not confirm to the specification and was unprocessed and rejected. Please fix the value and try again
- enum : error, warn, invalid, fatal
- type : string
-
code
- Error code which qualifies the error
- type : string
-
details
- Human readable explanation specific to the occurrence of the problem
- type : string
-
location
- The name of the field that resulted in the error
- type : string
-
moreInfo
- URI to human readable documentation of the error
- type : object
-
required
- type
- code
Example Response for get
/v1/insurance/bookings/sourceAccounts
400
| Type | Code | Details |
| invalid | invalidRequest | Missing or invalid Parameters |
Definitions
-
type
- Invalid - Request did not confirm to the specification and was unprocessed and rejected. Please fix the value and try again
- enum : error, warn, invalid, fatal
- type : string
-
code
- Error code which qualifies the error
- type : string
-
details
- Human readable explanation specific to the occurrence of the problem
- type : string
-
location
- The name of the field that resulted in the error
- type : string
-
moreInfo
- URI to human readable documentation of the error
- type : object
-
required
- type
- code
Response Schema for get
/v1/insurance/bookings/sourceAccounts
{
"properties": {
"type": {
"description": "Invalid - Request did not confirm to the specification and was unprocessed and rejected. Please fix the value and try again",
"enum": [
"error",
"warn",
"invalid",
"fatal"
],
"type": "string"
},
"code": {
"description": "Error code which qualifies the error",
"type": "string"
},
"details": {
"description": "Human readable explanation specific to the occurrence of the problem",
"type": "string"
},
"location": {
"description": "The name of the field that resulted in the error",
"type": "string"
},
"moreInfo": {
"description": "URI to human readable documentation of the error",
"type": "object"
}
},
"required": [
"type",
"code"
]
}
401
| error | unAuthorized | Authorization credentials are missing or invalid |
Definitions
-
type
- Invalid - Request did not confirm to the specification and was unprocessed and rejected. Please fix the value and try again
- enum : error, warn, invalid, fatal
- type : string
-
code
- Error code which qualifies the error
- type : string
-
details
- Human readable explanation specific to the occurrence of the problem
- type : string
-
location
- The name of the field that resulted in the error
- type : string
-
moreInfo
- URI to human readable documentation of the error
- type : object
-
required
- type
- code
Response Schema for get
/v1/insurance/bookings/sourceAccounts
{
"properties": {
"type": {
"description": "Invalid - Request did not confirm to the specification and was unprocessed and rejected. Please fix the value and try again",
"enum": [
"error",
"warn",
"invalid",
"fatal"
],
"type": "string"
},
"code": {
"description": "Error code which qualifies the error",
"type": "string"
},
"details": {
"description": "Human readable explanation specific to the occurrence of the problem",
"type": "string"
},
"location": {
"description": "The name of the field that resulted in the error",
"type": "string"
},
"moreInfo": {
"description": "URI to human readable documentation of the error",
"type": "object"
}
},
"required": [
"type",
"code"
]
}
403
| error | accessNotConfigured | Access is not configured for this resource |
Definitions
-
type
- Invalid - Request did not confirm to the specification and was unprocessed and rejected. Please fix the value and try again
- enum : error, warn, invalid, fatal
- type : string
-
code
- Error code which qualifies the error
- type : string
-
details
- Human readable explanation specific to the occurrence of the problem
- type : string
-
location
- The name of the field that resulted in the error
- type : string
-
moreInfo
- URI to human readable documentation of the error
- type : object
-
required
- type
- code
Response Schema for get
/v1/insurance/bookings/sourceAccounts
{
"properties": {
"type": {
"description": "Invalid - Request did not confirm to the specification and was unprocessed and rejected. Please fix the value and try again",
"enum": [
"error",
"warn",
"invalid",
"fatal"
],
"type": "string"
},
"code": {
"description": "Error code which qualifies the error",
"type": "string"
},
"details": {
"description": "Human readable explanation specific to the occurrence of the problem",
"type": "string"
},
"location": {
"description": "The name of the field that resulted in the error",
"type": "string"
},
"moreInfo": {
"description": "URI to human readable documentation of the error",
"type": "object"
}
},
"required": [
"type",
"code"
]
}
500
| fatal | serverUnavailable | The request failed due to an internal error |
Definitions
-
type
- Invalid - Request did not confirm to the specification and was unprocessed and rejected. Please fix the value and try again
- enum : error, warn, invalid, fatal
- type : string
-
code
- Error code which qualifies the error
- type : string
-
details
- Human readable explanation specific to the occurrence of the problem
- type : string
-
location
- The name of the field that resulted in the error
- type : string
-
moreInfo
- URI to human readable documentation of the error
- type : object
-
required
- type
- code
Response Schema for get
/v1/insurance/bookings/sourceAccounts
{
"properties": {
"type": {
"description": "Invalid - Request did not confirm to the specification and was unprocessed and rejected. Please fix the value and try again",
"enum": [
"error",
"warn",
"invalid",
"fatal"
],
"type": "string"
},
"code": {
"description": "Error code which qualifies the error",
"type": "string"
},
"details": {
"description": "Human readable explanation specific to the occurrence of the problem",
"type": "string"
},
"location": {
"description": "The name of the field that resulted in the error",
"type": "string"
},
"moreInfo": {
"description": "URI to human readable documentation of the error",
"type": "object"
}
},
"required": [
"type",
"code"
]
}Book Customer Insurance With Offline Payment
post
/v1/insurance/bookings/withOfflinePayments
This API is used to add insurance booking details of the customer without debiting the premium amount.
Header Parameters
Authorization
string
required
The most recent Authorization token. This will have the format Bearer + {space} + {accessToken}. Example: Bearer KGNsaWVudF9pZDpjbGllbnRfc2VjcmV0KQ==.
uuid
string
required
128 bit random UUID generated uniquely for every request.
Accept
string
required
Content-Type that are acceptable for the response.
client_id
string
required
Client ID generated during application registration.
Content-Type
string
required
application/json
clientDetails
string
Optional
This field is used to capture device,browser and network information. Refer the developer portal for more information.These are the fields which will be passed as part of the header devicePrint,deviceTokenCookie,userIpAddress,userAgent,hardwareId,simId,deviceModel,deviceName,deviceOsName,deviceOsVersion,multitaskingSupportFlag,languageSupport,wifiMacAddress,cellTowerId,locationAreaCode,rsaApplicationKey,wapClientId,mobileCarrierCode,mobileCountryCode,osId,geoLongitude,geoLatitude,geoHorizontalAccuracy,geoAltitude,geoAltitudeAccuracy,geoSpeed,geoTimestamp,geoStatus,basicServiceSetId,signalStrength,wifiChannel,serviceSetId
Body Parameters
InsuranceBookingRequest
required
InsuranceBookingRequest
Show schema
×
object: InsuranceBookingRequest
{
"properties": {
"offerDetails": {
"properties": {
"waveId": {
"description": "Unique identifier for the promotion under specific campaign being offered to the channel",
"type": "string",
"example": 987654321
},
"campaignId": {
"description": "Unique identifier for a specific campaign being offered to the channel",
"type": "string",
"example": 123456789
},
"offerId": {
"description": "Unique offer ID associated with the offer",
"type": "string",
"example": 111000125
}
},
"required": [
"campaignId"
]
},
"policyDetails": {
"properties": {
"insuranceProductCode": {
"description": "Insurance product code",
"type": "string",
"example": "PR001- PAGOS PROTEGIDOS BASICO"
},
"insuranceProductCurrencyCode": {
"description": "Currency code of the insurance in ISO 4217 format.",
"type": "string",
"example": "SGD"
},
"insurancePolicyNumber": {
"description": "Policy number of the insurance product.",
"type": "string",
"example": "83748374389"
},
"insurancePolicyStatus": {
"description": "Status of the insurance policy. This is a reference data field. Please use \/utilities\/referenceData\/{insurancePolicyStatus} resource to get valid values of this field with descriptions.",
"type": "string",
"example": "CONFIRMED"
},
"insuranceSumAssuredAmount": {
"description": "It is the guaranteed amount the policy holder will receive",
"type": "number",
"format": "double",
"example": 25000.12
},
"insurancePremiumPaymentFrequency": {
"description": "Frequency of premium payment. This is a reference data field. Please use \/utilities\/referenceData\/{insurancePremiumPaymentFrequency} resource to get valid values of this field with descriptions.",
"type": "string",
"example": "MONTHLY"
},
"policyTermType": {
"description": "Benefit Tenure in months or years. This is a reference data field. Please use \/utilities\/referenceData\/{policyTermType} resource to get valid values of this field with descriptions.",
"type": "string",
"example": "MONTHS"
},
"policyTerm": {
"description": "The period of coverage provided by an insurance policy.",
"type": "number",
"format": "integer",
"example": 120
},
"premiumPaymentTermType": {
"description": "Premium Tenure in months or years. This is a reference data field. Please use \/utilities\/referenceData\/{premiumPaymentTermType} resource to get valid values of this field with descriptions.",
"type": "string",
"example": "MONTHS"
},
"premiumPaymentTerm": {
"description": "It is the total number of months for the policy holder to pay the premium.",
"type": "number",
"format": "integer",
"example": 180
},
"policyBillingMode": {
"description": "Indicates whether billing will be done by Citi or by external party or by both. This is a reference data field. Please use \/utilities\/referenceData\/{policyBillingMode} resource to get valid values of this field with descriptions.",
"type": "string",
"example": "INTERNAL"
},
"applicationDate": {
"description": "Date on which application is created in ISO 8601 date format YYYY-MM-DD",
"type": "string",
"format": "date",
"example": "2018-10-01'"
},
"insurancePolicyEffectiveDate": {
"description": "Date at which an insurance policy goes into force.",
"type": "string",
"format": "date",
"example": "2018-11-01"
},
"basePremiumAmount": {
"description": "It is the specified amount stipulated by the insurance company, which the insured individual should periodically pay to maintain the actual coverage of insurance.",
"type": "number",
"format": "double",
"example": 1000.21
},
"addOnPremiumAmount": {
"description": "Add-on premium amount",
"type": "number",
"format": "double",
"example": 100.52
},
"totalPremiumAmount": {
"description": "It is the sum of base premium amount and add on premium amount.",
"type": "number",
"format": "double",
"example": 1110.73
},
"policyMaturityDate": {
"description": "Date when policy will be matured",
"type": "string",
"format": "date",
"example": "2028-11-01'"
},
"legalAgreementFlag": {
"description": "This flag is used to indicate whether the customer is agreeing on the legal agreement.",
"type": "string",
"format": "boolean",
"example": true
},
"firstPremiumDueDate": {
"description": "Date on which first premium is due.",
"type": "string",
"format": "date",
"example": "2018-10-05'"
}
},
"required": [
"insuranceProductCode",
"insuranceProductCurrencyCode",
"insurancePolicyNumber",
"insurancePolicyStatus",
"insuranceSumAssuredAmount",
"insurancePremiumPaymentFrequency",
"policyTermType",
"policyTerm",
"premiumPaymentTermType",
"premiumPaymentTerm",
"policyBillingMode",
"applicationDate",
"insurancePolicyEffectiveDate",
"basePremiumAmount",
"totalPremiumAmount",
"policyMaturityDate"
]
},
"riderDetails": {
"type": "array",
"items": {
"properties": {
"riderCode": {
"description": "It is the unique code associated with the insurance rider(Insurance rider is an optional add-on to an insurance policy. It is a provision of an insurance policy that adds to or amends the coverage or terms.)",
"type": "string",
"example": "TP1"
},
"riderSumAssuredAmount": {
"description": "Sum assured amount for the rider.",
"type": "number",
"format": "double",
"example": 25000.11
},
"addOnPremiumAmount": {
"description": "Add-on premium for the rider.",
"type": "number",
"format": "double"
},
"riderTermType": {
"description": "Rider premium payment tenure type. This is a reference data field. Please use \/utilities\/referenceData\/{riderTermType} resource to get valid values of this field with descriptions.",
"type": "string",
"example": "MONTHS"
},
"riderTerm": {
"description": "Rider premium payment tenure",
"type": "number",
"format": "integer",
"example": 60
},
"riderEffectiveDate": {
"description": "Rider Effective Date",
"type": "string",
"format": "date",
"example": 1546214400000
}
},
"required": [
"riderCode",
"riderSumAssuredAmount",
"addOnPremiumAmount",
"riderTermType",
"riderTerm",
"riderEffectiveDate"
]
}
},
"applicant": {
"type": "array",
"items": {
"properties": {
"name": {
"properties": {
"salutation": {
"description": "This field is to indicate the salutation of the applicant.This is a reference data field. Please use \/v1\/apac\/utilities\/referenceData\/{salutation} resource to get possible value of this field with description.",
"type": "string",
"example": "MR."
},
"givenName": {
"description": "Given\/first name of the applicant",
"type": "string",
"example": "Javier"
},
"middleName": {
"description": "Middle name of the applicant",
"type": "string",
"example": "Perez"
},
"surname": {
"description": "Surname\/last name of the applicant.",
"type": "string",
"example": "de Cuellar"
}
},
"required": [
"salutation",
"givenName",
"surname"
]
},
"identificationDocumentDetails": {
"type": "array",
"items": {
"properties": {
"idType": {
"description": "Type of Identification document. This is a reference data field. Please use \/v1\/utilities\/referenceData\/{idType} resource to get valid values of this field with descriptions",
"type": "string",
"example": "PASSPORT"
},
"idNumber": {
"description": "Unique identifier of identification document.",
"type": "string",
"example": "Passport- 443431, CIN- 123123123"
}
},
"required": [
"idType",
"idNumber"
]
}
},
"demographics": {
"properties": {
"gender": {
"description": "Gender of the Insured. Please use \/v1\/apac\/utilities\/referenceData\/{gender} resource to get valid value of this field with description.",
"type": "string",
"example": "MALE"
},
"dateOfBirth": {
"description": "Date of Birth of the Insured in ISO 8601 date format YYYY-MM-DD",
"type": "string",
"format": "date",
"example": "1980-01-01"
},
"maritalStatus": {
"description": "Applicants marital status. Please use \/v1\/apac\/utilities\/referenceData\/{maritalStatus} resource to get valid value of this field with description. ",
"type": "string",
"example": "SINGLE"
},
"nationality": {
"description": "Applicants nationality. Please use \/v1\/apac\/utilities\/referenceData\/{nationality} resource to get valid value of this field with description.",
"type": "string",
"example": "SG"
}
},
"required": [
"dateOfBirth"
]
},
"employmentDetails": {
"properties": {
"occupationCode": {
"description": "Occupation code. Please use \/utilities\/referenceData\/{occupationCode} resource to get valid values of this field with descriptions.",
"type": "string",
"example": "ACCOUNTANT"
},
"businessNature": {
"description": "Occupation category which represents the business nature it belongs to. This is a reference data field. Please use \/v1\/utilities\/referenceData\/{businessNature} resource to get valid value of this field with description.",
"type": "string",
"example": "BANKING"
}
}
},
"ownershipType": {
"description": "Indicates whether the insured is also the owner of the policy. This is a reference data field. Please use \/utilities\/referenceData\/{ownershipType} resource to get valid values of this field with descriptions.",
"type": "string",
"example": "OWNER"
},
"additionalData": {
"properties": {
"relationshipWithPrimary": {
"description": "Relationship of the Insured with the owner. This is a reference data field. Please use \/utilities\/referenceData\/{relationshipWithPrimary} resource to get valid values of this field with descriptions.",
"type": "string",
"example": "HUSBAND"
}
},
"required": [
"relationshipWithPrimary"
]
},
"email": {
"type": "array",
"items": {
"properties": {
"emailAddress": {
"description": "Applicants email address",
"type": "string",
"example": "javier@abcd.com"
}
},
"required": [
"emailAddress"
]
}
},
"address": {
"type": "array",
"items": {
"properties": {
"addressLine1": {
"description": "Address line 1",
"type": "string",
"example": "40A Orchard Road"
},
"addressLine2": {
"description": "Address line 2",
"type": "string",
"example": "#99-99 Macdonald House"
},
"addressLine3": {
"description": "Address line 3",
"type": "string",
"example": "Orchard Avenue 2"
},
"addressLine4": {
"description": "Address line 4",
"type": "string",
"example": "Street 65"
},
"cityName": {
"description": "City",
"type": "string",
"example": "Singapore"
},
"state": {
"description": "State. This is a reference data field. Please use \/utilities\/referenceData\/{addressState} resource to get possible values of this field with descriptions.",
"type": "string",
"example": "SINGAPORE"
},
"postalCode": {
"description": "Postal\/ZIP code",
"type": "string",
"example": 520189
},
"countryCode": {
"description": "ISO country code. This is a reference data field. Please use \/utilities\/referenceData\/{country} resource to get possible values of this field with descriptions.",
"type": "string"
}
},
"required": [
"addressLine1",
"postalCode"
]
}
},
"phone": {
"type": "array",
"items": {
"properties": {
"phoneNumber": {
"description": "Applicants phone number",
"type": "string"
},
"phoneCountryCode": {
"description": "Country calling code. This is a reference data field. Please use \/utilities\/referenceData\/{phoneCountryCode} resource to get possible values of this field with descriptions.",
"type": "string",
"example": "65"
},
"areaCode": {
"description": "The area code of phone number",
"type": "string"
},
"extension": {
"description": "Extension of telephone number",
"type": "string"
}
},
"required": [
"phoneNumber",
"phoneCountryCode"
]
}
}
},
"required": [
"name",
"ownershipType"
]
}
},
"initialPaymentDetails": {
"properties": {
"sourceAccountId": {
"description": "The source account identifier of the IPA in encrypted format.Typically, this is not displayed to the customer.",
"type": "string",
"example": "3c344e38756339654972776f663745446e6d4c32486f455a4165374a476858343d"
}
},
"required": [
"sourceAccountId"
]
},
"premiumSourceAccount": {
"properties": {
"sourceAccountId": {
"description": "The source account identifier of the premium account in encrypted format.Typically, this is not displayed to the customer.",
"type": "string",
"example": "1234567896f2b4d4d796c344e387563374a476jfhjd23478377889738343d"
}
},
"required": [
"sourceAccountId"
]
},
"beneficiary": {
"type": "array",
"items": {
"properties": {
"identificationDocumentDetails": {
"type": "array",
"items": {
"properties": {
"idType": {
"description": "Type of Identification document. This is a reference data field. Please use \/v1\/utilities\/referenceData\/{idType} resource to get valid values of this field with descriptions",
"type": "string",
"example": "PASSPORT"
},
"idNumber": {
"description": "Unique identifier of identification document.",
"type": "string",
"example": "Passport- 443431, CIN- 123123123"
}
},
"required": [
"idType",
"idNumber"
]
}
},
"name": {
"properties": {
"salutation": {
"description": "This field is to indicate the salutation of the applicant.This is a reference data field. Please use \/v1\/apac\/utilities\/referenceData\/{salutation} resource to get possible value of this field with description.",
"type": "string",
"example": "MR."
},
"givenName": {
"description": "Given\/first name of the applicant",
"type": "string",
"example": "Javier"
},
"middleName": {
"description": "Middle name of the applicant",
"type": "string",
"example": "Perez"
},
"surname": {
"description": "Surname\/last name of the applicant.",
"type": "string",
"example": "de Cuellar"
}
},
"required": [
"salutation",
"givenName",
"surname"
]
},
"demographics": {
"properties": {
"gender": {
"description": "Gender of the Insured. Please use \/v1\/apac\/utilities\/referenceData\/{gender} resource to get valid value of this field with description.",
"type": "string",
"example": "MALE"
},
"dateOfBirth": {
"description": "Date of Birth of the Insured in ISO 8601 date format YYYY-MM-DD",
"type": "string",
"format": "date",
"example": "1980-01-01"
},
"maritalStatus": {
"description": "Applicants marital status. Please use \/v1\/apac\/utilities\/referenceData\/{maritalStatus} resource to get valid value of this field with description. ",
"type": "string",
"example": "SINGLE"
},
"nationality": {
"description": "Applicants nationality. Please use \/v1\/apac\/utilities\/referenceData\/{nationality} resource to get valid value of this field with description.",
"type": "string",
"example": "SG"
}
},
"required": [
"dateOfBirth"
]
},
"employmentDetails": {
"properties": {
"occupationCode": {
"description": "Occupation code. Please use \/utilities\/referenceData\/{occupationCode} resource to get valid values of this field with descriptions.",
"type": "string",
"example": "ACCOUNTANT"
},
"businessNature": {
"description": "Occupation category which represents the business nature it belongs to. This is a reference data field. Please use \/v1\/utilities\/referenceData\/{businessNature} resource to get valid value of this field with description.",
"type": "string",
"example": "BANKING"
}
}
},
"additionalData": {
"properties": {
"relationshipWithPrimary": {
"description": "Relationship of the Insured with the owner. This is a reference data field. Please use \/utilities\/referenceData\/{relationshipWithPrimary} resource to get valid values of this field with descriptions.",
"type": "string",
"example": "HUSBAND"
}
},
"required": [
"relationshipWithPrimary"
]
},
"insuranceSumAssuredAllocationPercentage": {
"description": "Allocation percentage of sum insured amount",
"type": "number",
"format": "double"
}
},
"required": [
"name",
"insuranceSumAssuredAllocationPercentage"
]
}
}
},
"required": [
"policyDetails"
]
}- cURL
- Ruby
- Python
- PHP
- Java
- Node
- Go
- Swift
Example Request
Example Request
Example Request
Example Request
Example Request
Example Request
Example Request
Example Request
200
Successful operation.
This operation returns no content.
400
| Type | Code | Details |
| invalid | invalidRequest | Missing or invalid Parameters |
Definitions
-
type
- Invalid - Request did not confirm to the specification and was unprocessed and rejected. Please fix the value and try again
- enum : error, warn, invalid, fatal
- type : string
-
code
- Error code which qualifies the error
- type : string
-
details
- Human readable explanation specific to the occurrence of the problem
- type : string
-
location
- The name of the field that resulted in the error
- type : string
-
moreInfo
- URI to human readable documentation of the error
- type : object
-
required
- type
- code
Response Schema for post
/v1/insurance/bookings/withOfflinePayments
{
"properties": {
"type": {
"description": "Invalid - Request did not confirm to the specification and was unprocessed and rejected. Please fix the value and try again",
"enum": [
"error",
"warn",
"invalid",
"fatal"
],
"type": "string"
},
"code": {
"description": "Error code which qualifies the error",
"type": "string"
},
"details": {
"description": "Human readable explanation specific to the occurrence of the problem",
"type": "string"
},
"location": {
"description": "The name of the field that resulted in the error",
"type": "string"
},
"moreInfo": {
"description": "URI to human readable documentation of the error",
"type": "object"
}
},
"required": [
"type",
"code"
]
}
401
| Type | Code | Details |
| error | unAuthorized | Authorization credentials are missing or invalid |
Definitions
-
type
- Invalid - Request did not confirm to the specification and was unprocessed and rejected. Please fix the value and try again
- enum : error, warn, invalid, fatal
- type : string
-
code
- Error code which qualifies the error
- type : string
-
details
- Human readable explanation specific to the occurrence of the problem
- type : string
-
location
- The name of the field that resulted in the error
- type : string
-
moreInfo
- URI to human readable documentation of the error
- type : object
-
required
- type
- code
Response Schema for post
/v1/insurance/bookings/withOfflinePayments
{
"properties": {
"type": {
"description": "Invalid - Request did not confirm to the specification and was unprocessed and rejected. Please fix the value and try again",
"enum": [
"error",
"warn",
"invalid",
"fatal"
],
"type": "string"
},
"code": {
"description": "Error code which qualifies the error",
"type": "string"
},
"details": {
"description": "Human readable explanation specific to the occurrence of the problem",
"type": "string"
},
"location": {
"description": "The name of the field that resulted in the error",
"type": "string"
},
"moreInfo": {
"description": "URI to human readable documentation of the error",
"type": "object"
}
},
"required": [
"type",
"code"
]
}
403
| Type | Code | Details |
| error | accessNotConfigured | The request operation is not configured to access this resource |
| error | mfaRequired | MFA is required |
| error | transactiondenied | Transaction Denied |
Definitions
-
type
- Invalid - Request did not confirm to the specification and was unprocessed and rejected. Please fix the value and try again
- enum : error, warn, invalid, fatal
- type : string
-
code
- Error code which qualifies the error
- type : string
-
details
- Human readable explanation specific to the occurrence of the problem
- type : string
-
location
- The name of the field that resulted in the error
- type : string
-
moreInfo
- URI to human readable documentation of the error
- type : object
-
required
- type
- code
Response Schema for post
/v1/insurance/bookings/withOfflinePayments
{
"properties": {
"type": {
"description": "Invalid - Request did not confirm to the specification and was unprocessed and rejected. Please fix the value and try again",
"enum": [
"error",
"warn",
"invalid",
"fatal"
],
"type": "string"
},
"code": {
"description": "Error code which qualifies the error",
"type": "string"
},
"details": {
"description": "Human readable explanation specific to the occurrence of the problem",
"type": "string"
},
"location": {
"description": "The name of the field that resulted in the error",
"type": "string"
},
"moreInfo": {
"description": "URI to human readable documentation of the error",
"type": "object"
}
},
"required": [
"type",
"code"
]
}
422