AuthorizePartyAuthenticationAssessmentBiometricFacialRecognitionRequest

{
    "properties": {
        "imageFiles": {
            "type": "array",
            "items": {
                "$ref": "#/definitions/ImageFiles"
            }
        },
        "delta": {
            "description": "Eencrypted string to idenfity images",
            "type": "string",
            "example": "CxsBvwfoFafOIq***83=="
        }
    },
    "required": [
        "delta"
    ]
}
              

ImageFiles

{
    "properties": {
        "fileName": {
            "description": "The name of the image file.",
            "type": "string",
            "example": "image1"
        },
        "fileContent": {
            "description": "Base 64 value for the image",
            "type": "string",
            "example": "/9*k="
        }
    },
    "required": [
        "fileName",
        "fileContent"
    ]
}
              

RequestPartyAuthenticationAssessmentInitializationRequest

{
    "properties": {
        "controlFlowId": {
            "description": "Control flow id is used to control the flow for subsequent requests in the session.",
            "type": "string",
            "example": "6e3774334f724a2b7947663653712f52456f524c41797038516a59347a437549564a77755676376e616a733d"
        },
        "applicationId": {
            "description": "Unique identifier for the application.",
            "type": "string",
            "example": "UIT56RSE4JMN"
        },
        "productType": {
            "description": "flag to identify ekyc_RCE flow",
            "type": "string",
            "example": "CARD"
        },
        "applicant": {
            "$ref": "#/definitions/Applicant"
        }
    },
    "required": [
        "controlFlowId"
    ]
}
              

Applicant

{
    "properties": {
        "phone": {
            "type": "array",
            "items": {
                "$ref": "#/definitions/Phone"
            }
        }
    }
}
              

Phone

{
    "properties": {
        "phoneType": {
            "description": "The type of phone. Ex:OFFICE, HOME, MOBILE, PRIMARY_MOBILE, FAX. This is a reference data data field. Please use /v1/utilities/referenceData/{phoneType} resource to get valid value of this field with description.",
            "type": "string",
            "example": "PRIMARY_MOBILE_NUMBER"
        },
        "phoneCountryCode": {
            "description": "Country code of telephone number",
            "type": "string",
            "example": 65
        },
        "areaCode": {
            "description": "The area code of telephone number",
            "type": "string",
            "example": "02"
        },
        "phoneNumber": {
            "description": "The phone number of applicant",
            "type": "string",
            "example": 64043401
        }
    },
    "required": [
        "phoneType",
        "phoneCountryCode",
        "phoneNumber"
    ]
}
              

RequestPartyAuthenticationAssessmentInitializationResponse

{
    "properties": {
        "eKycUniqueId": {
            "description": "Unique ID for tracing the journey of eKYC flow.",
            "type": "string",
            "example": "abc12345"
        },
        "controlFlowId": {
            "description": "Control flow id is used to control the flow for subsequent requests in the session.",
            "type": "string",
            "example": "6e3774334f724a2b7947663653712f52456f524c41797038516a59347a437549564a77755676376e616a733d"
        }
    },
    "required": [
        "eKycUniqueId"
    ]
}
              

RequestPartyAuthenticationAssessmentDocumentIdentificationInitializationRequest

{
    "properties": {
        "controlFlowId": {
            "description": "Control flow id is used to control the flow for subsequent requests in the session.",
            "type": "string",
            "example": "6e3774334f724a2b7947663653712f52456f524c41797038516a59347a437549564a77755676376e616a733d"
        },
        "applicationId": {
            "description": "Unique identifier for the application.",
            "type": "string",
            "example": "UIT56RSE4JMN"
        },
        "eKycUniqueId": {
            "description": "Unique ID for tracing the journey of eKYC flow.",
            "type": "string",
            "example": "abc-1234"
        },
        "sdkMetaData": {
            "description": "Meta information of the SDK.",
            "type": "string",
            "example": "MOB_H5"
        },
        "customerIdentifier": {
            "description": "Unique customer identifier (mobile phone number, email address) that may be used by vendor to associate transactions and apply business rules",
            "type": "string",
            "example": "test.email@citi.com"
        },
        "documentIdType": {
            "description": "Classification of the document (eg. National ID, Income Proof, etc.). This is a reference data field. Please use /v1/apac/utilities/referenceData/{documentIdType} resource to get valid value of this field with description ",
            "type": "string",
            "example": "00000001003"
        },
        "pages": {
            "description": "Document pages, split by comma if there are more than 1 page.",
            "type": "string",
            "example": "1,2"
        },
        "retakeFlag": {
            "description": "Flag to indicate if capture of identification document is a retake.",
            "type": "boolean",
            "example": true
        },
        "productType": {
            "description": "Type of the product.This is a reference data field. Please use /v1/utilities/referenceData/{productType} resource to get valid values of this field with descriptions",
            "type": "string",
            "example": "CARD"
        }
    },
    "required": [
        "controlFlowId",
        "eKycUniqueId",
        "sdkMetaData",
        "documentIdType",
        "proofType",
        "pages",
        "retakeFlag"
    ]
}
              

RequestPartyAuthenticationAssessmentDocumentIdentificationInitializationResponse

{
    "properties": {
        "clientConfiguration": {
            "description": "Client configuration, the protocol json string that needs to be passed to ZOLOZ SDK",
            "type": "string",
            "example": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
        },
        "transactionId": {
            "description": "The unique ID generated by vendor for tracing each transaction",
            "type": "string",
            "example": "G00000000192c672ce7cacf18dbeb6b4d3da8760f0"
        }
    },
    "required": [
        "transactionId"
    ]
}
              

RetrievePartyAuthenticationAssessmentDocumentIdentificationResultsRequest

{
    "properties": {
        "controlFlowId": {
            "description": "Control flow id is used to control the flow for subsequent requests in the session.",
            "type": "string",
            "example": "6e3774334f724a2b7947663653712f52456f524c41797038516a59347a437549564a77755676376e616a733d"
        },
        "applicationId": {
            "description": "Unique identifier for the application.",
            "type": "string",
            "example": "UIT56RSE4JMN"
        },
        "eKycUniqueId": {
            "description": "Unique ID for tracing the journey of eKYC flow.",
            "type": "string",
            "example": "abc12345"
        },
        "transactionId": {
            "description": "The unique ID generated by vendor for tracing each transaction.",
            "type": "string",
            "example": "G00000000192c672ce7cacf18dbeb6b4d3da8760f0"
        },
        "productType": {
            "description": "Type of the product.This is a reference data field. Please use /v1/utilities/referenceData/{productType} resource to get valid values of this field with descriptions",
            "type": "string",
            "example": "CARD"
        }
    },
    "required": [
        "controlFlowId",
        "eKycUniqueId",
        "transactionId"
    ]
}
              

RetrievePartyAuthenticationAssessmentDocumentIdentificationResultsResponse

{
    "properties": {
        "ocrResult": {
            "description": "OCR results in JSON format",
            "type": "string",
            "example": "{\"ID_NUMBER\": \"xxxx\",\"COUNTRY\": \"xxxxx\",\"SEX\": \"M\", \"...\":\"...\"}"
        },
        "spoofResult": {
            "description": "Spoof results in JSON Format",
            "type": "string",
            "example": "{\"TAMPER_CHECK\": \"Y\", \"MATERIAL_CHECK\": \"Y\", \"SCREEN_RECAPTURE_CHECK\": \"Y\"}"
        },
        "recognitionErrorCode": {
            "description": "Identification document recognition error code",
            "type": "string",
            "example": "NO_FACE_DETECTED"
        },
        "recognitionResult": {
            "description": "Identification document recognition result",
            "type": "string",
            "example": "Y"
        },
        "retryCount": {
            "description": "Retry count of id verification",
            "type": "number",
            "format": "integer",
            "example": 1
        }
    },
    "required": [
        "transactionId"
    ]
}
              

RequestPartyAuthenticationAssessmentBiometricFaceCaptureInitializationRequest

{
    "properties": {
        "controlFlowId": {
            "description": "Control flow id is used to control the flow for subsequent requests in the session.",
            "type": "string",
            "example": "6e3774334f724a2b7947663653712f52456f524c41797038516a59347a437549564a77755676376e616a733d"
        },
        "applicationId": {
            "description": "Unique identifier for the application.",
            "type": "string",
            "example": "UIT56RSE4JMN"
        },
        "eKycUniqueId": {
            "description": "Unique ID for tracing the journey of eKYC flow.",
            "type": "string",
            "example": "abc12345"
        },
        "sdkMetaData": {
            "description": "Meta information of the SDK.",
            "type": "string",
            "example": "MOB_H5"
        },
        "customerIdentifier": {
            "description": "Unique customer identifier (mobile phone number, email address) that may be used by vendor to associate transactions and apply business rules.",
            "type": "string",
            "example": "test.email@citi.com"
        },
        "productType": {
            "description": "Type of the product.This is a reference data field. Please use /v1/utilities/referenceData/{productType} resource to get valid values of this field with descriptions",
            "type": "string",
            "example": "CARD"
        }
    },
    "required": [
        "controlFlowId",
        "eKycUniqueId",
        "sdkMetaData"
    ]
}
              

RequestPartyAuthenticationAssessmentBiometricFaceCaptureInitializationResponse

{
    "properties": {
        "clientConfiguration": {
            "description": "Client configuration, the protocol json string that needs to be passed to ZOLOZ SDK",
            "type": "string",
            "example": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
        },
        "transactionId": {
            "description": "The unique ID generated by vendor for tracing each transaction.",
            "type": "string",
            "example": "G00000000192c672ce7cacf18dbeb6b4d3da8760f0"
        }
    },
    "required": [
        "transactionId"
    ]
}
              

RetrievePartyAuthenticationAssessmentBiometricFaceCaptureResultsRequest

{
    "properties": {
        "controlFlowId": {
            "description": "Control flow id is used to control the flow for subsequent requests in the session.",
            "type": "string",
            "example": "6e3774334f724a2b7947663653712f52456f524c41797038516a59347a437549564a77755676376e616a733d"
        },
        "applicationId": {
            "description": "Unique identifier for the application.",
            "type": "string",
            "example": "UIT56RSE4JMN"
        },
        "eKycUniqueId": {
            "description": "Unique ID for tracing the journey of eKYC flow.",
            "type": "string",
            "example": "abc12345"
        },
        "transactionId": {
            "description": "The unique ID generated by vendor for tracing each transaction.",
            "type": "string",
            "example": "abc12345"
        },
        "productType": {
            "description": "Type of the product.This is a reference data field. Please use /v1/utilities/referenceData/{productType} resource to get valid values of this field with descriptions",
            "type": "string",
            "example": "CARD"
        }
    },
    "required": [
        "controlFlowId",
        "eKycUniqueId",
        "transactionId"
    ]
}
              

RetrievePartyAuthenticationAssessmentBiometricFaceCaptureResultsResponse

{
    "properties": {
        "livenessCheckFailedFlag": {
            "description": "Liveness check result",
            "type": "boolean",
            "example": "true"
        },
        "qualityScore": {
            "description": "Selfie image quality score",
            "type": "number",
            "format": "double",
            "example": 97.61517973846627
        },
        "retryCount": {
            "description": "Retry count of id verification",
            "type": "number",
            "format": "integer",
            "example": 1
        }
    },
    "required": [
        "transactionId"
    ]
}
              

EvaluatePartyAuthenticationAssessmentFaceComparisonAndRiskRequest

{
    "properties": {
        "controlFlowId": {
            "description": "Control flow id is used to control the flow for subsequent requests in the session.",
            "type": "string",
            "example": "6e3774334f724a2b7947663653712f52456f524c41797038516a59347a437549564a77755676376e616a733d"
        },
        "applicationId": {
            "description": "Unique identifier for the application.",
            "type": "string",
            "example": "UIT56RSE4JMN"
        },
        "eKycUniqueId": {
            "description": "Unique ID for tracing the journey of eKYC flow.",
            "type": "string",
            "example": "abc12345"
        },
        "productType": {
            "description": "Type of the product.This is a reference data field. Please use /v1/utilities/referenceData/{productType} resource to get valid values of this field with descriptions",
            "type": "string",
            "example": "CARD"
        }
    },
    "required": [
        "controlFlowId",
        "eKycUniqueId"
    ]
}
              

EvaluatePartyAuthenticationAssessmentFaceComparisonAndRiskResponse

{
    "properties": {
        "facialRecognitionVerificationResult": {
            "description": "Flag to indicate if ID Card photo and selfie are the same person based on algorithm.",
            "type": "boolean",
            "example": true
        },
        "facialRecognitionVerificationScore": {
            "description": "Face comparison score.",
            "type": "number",
            "format": "double",
            "example": 88.2
        },
        "riskDetail": {
            "description": "Risk detail in JSON format",
            "type": "string",
            "example": "{\"type\": \"FAKE_ID\", \"alike\": \"userID1,userID2,userID3\"}"
        }
    },
    "required": [
        "facialRecognitionVerificationScore",
        "facialRecognitionVerificationResult"
    ]
}
              

RetrievePartyAuthenticationAssessmentFormattedApplicantInfoRequest

{
    "properties": {
        "controlFlowId": {
            "description": "Control flow id is used to control the flow for subsequent requests in the session.",
            "type": "string",
            "example": "6e3774334f724a2b7947663653712f52456f524c41797038516a59347a437549564a77755676376e616a733d"
        },
        "applicationId": {
            "description": "Unique identifier for the application.",
            "type": "string",
            "example": "UIT56RSE4JMN"
        },
        "eKycUniqueId": {
            "description": "Unique ID for tracing the journey of eKYC flow.",
            "type": "string",
            "example": "abc12345"
        },
        "productType": {
            "description": "Type of the product.This is a reference data field. Please use /v1/utilities/referenceData/{productType} resource to get valid values of this field with descriptions",
            "type": "string",
            "example": "CARD"
        }
    },
    "required": [
        "controlFlowId",
        "eKycUniqueId"
    ]
}
              

RetrievePartyAuthenticationAssessmentFormattedApplicantInfoResponse

{
    "properties": {
        "customerDetails": {
            "type": "array",
            "items": {
                "$ref": "#/definitions/CustomerDetail"
            }
        }
    },
    "required": [
        "customerDetails"
    ]
}
              

CustomerDetail

{
    "properties": {
        "attribute": {
            "description": "Attribute of customer personal data, the attribute name will have the Citi attribute names. Example attributes: givenName, surname, middleName, gender, dateOfBirth, placeOfBirth, bloodType, maritalStatus, nationality, nationalIdNumber, nationalIdIssueDate, legalAddressLine1, legalAddressLine2, legalAddressCityName, legalAddressState",
            "type": "string",
            "example": "name"
        },
        "value": {
            "description": "The value of customer personal data corresponding to the attribute.",
            "type": "string",
            "example": "TAN AH MUI"
        },
        "editingAllowedFlag": {
            "description": "Flag to indicate if customer field data is allowed to be edited",
            "type": "boolean",
            "example": "true"
        },
        "valueModifiedFlag": {
            "description": "Flag to indicate if customer field data is truncated or modified (removed special characters)",
            "type": "boolean",
            "example": "true"
        }
    },
    "required": [
        "attribute",
        "editingAllowedFlag",
        "valueModifiedFlag"
    ]
}
              

RetrievePartyAuthenticationAssessmentIdentityProvidersRequest

{
    "properties": {
        "controlFlowId": {
            "description": "Control flow id is used to control the flow for subsequent requests in the session.",
            "type": "string",
            "example": "6e3774334f724a2b7947663653712f52456f524c41797038516a59347a437549564a77755676376e616a733d"
        },
        "applicationId": {
            "description": "Unique identifier for the application",
            "type": "string",
            "example": "ZOW9IO793854"
        },
        "productType": {
            "description": "This is a reference data field to identify the Product Type if it is CARD or CASA. Please use /v1/apac/utilities/referenceData/{productType} resource to get valid value of this field with description",
            "type": "string",
            "example": "CASA"
        }
    },
    "required": [
        "controlFlowId",
        "applicationId",
        "productType"
    ]
}
              

RetrievePartyAuthenticationAssessmentIdentityProvidersResponse

{
    "properties": {
        "applicant": {
            "$ref": "#/definitions/ApplicantIdentityProvider"
        }
    }
}
              

EvaluatePartyAuthenticationAssessmentIdentityProvidersRequest

{
    "properties": {
        "controlFlowId": {
            "description": "Control flow id is used to control the flow for subsequent requests in the session.",
            "type": "string",
            "example": "6e3774334f724a2b7947663653712f52456f524c41797038516a59347a437549564a77755676376e616a733d"
        },
        "applicationId": {
            "description": "Unique identifier for the application",
            "type": "string",
            "example": "ZOW9IO793854"
        },
        "applicant": {
            "$ref": "#/definitions/ApplicantIdentityProvider"
        },
        "productType": {
            "description": "This is a reference data field to identify the Product Type if its is CARD or CASA. Please use /v1/apac/utilities/referenceData/{productType} resource to get valid value of this field with description.",
            "type": "string",
            "example": "CASA"
        }
    },
    "required": [
        "controlFlowId",
        "applicationId",
        "productType"
    ]
}
              

ApplicantIdentityProvider

{
    "properties": {
        "identityProviders": {
            "type": "array",
            "items": {
                "$ref": "#/definitions/IdentityProviders"
            }
        }
    }
}
              

IdentityProviders

{
    "properties": {
        "identityProviderId": {
            "description": "Identity Provider Id retunred from NDID via DAP, which will be used by channel to displaying the Idps on page.",
            "type": "string",
            "example": "77Bank"
        },
        "displayingName": {
            "description": "Identity Provider name retunred from NDID via DAP, which will be used by channel to displaying Idp Name on page. Not used in this release.",
            "type": "string",
            "example": "77_Bank"
        },
        "displayingNameNative": {
            "description": "Identity Provider name native retunred from NDID via DAP, which will be used by channel to displaying Idp native Name on page. Not used in this release.",
            "type": "string",
            "example": "77_?????"
        }
    },
    "required": [
        "identityProviderId"
    ]
}
              

EvaluatePartyAuthenticationAssessmentIdentityProvidersResponse

{
    "properties": {
        "proxyReferenceId": {
            "description": "Proxy Reference Id of the query request., which is used to interface with NDID via DAP.  You can get it at response of verification request.",
            "type": "string",
            "example": "1234435erwj4324356-23425"
        },
        "ndidRequestId": {
            "description": "NDID request Id of the query request, will be displayed in channel page. You can get it at response of verification request.",
            "type": "string",
            "example": "3564754354675345"
        }
    },
    "required": [
        "proxyReferenceId",
        "ndidRequestId"
    ]
}
              

EvaluatePartyAuthenticationAssessmentNdidNotificationRequest

{
    "properties": {
        "proxyReferenceId": {
            "description": "Reference Id of the query request. You can get it at response of verification request.",
            "type": "string",
            "example": "1234435erwj4324356-23425"
        },
        "ndidRequestId": {
            "description": "NDID Reference Id of the query request. You can get it at response of verification request.",
            "type": "string",
            "example": "3564754354675345"
        },
        "notificationNdidStatus": {
            "description": "Status of the request. The possible values for status field are: PENDING, ACCEPTED, REJECTED, TIMEOUT, CANCELLED, REQUEST_ERROR, IDP_OR_AS_ERROR",
            "type": "string",
            "example": "ACCEPTED"
        },
        "identityProviderVerificationResults": {
            "type": "array",
            "items": {
                "$ref": "#/definitions/IdentityProviderVerificationResults"
            }
        },
        "authoritativeServiceResults": {
            "type": "array",
            "items": {
                "$ref": "#/definitions/AuthoritativeServiceResults"
            }
        },
        "signature": {
            "description": "The headers contains three separated fields of signature information:keyId = a unique name of the key to sign the content,algorithms = signature algorithms which is used. Currently �rs256� always is returned to indicate that RSA-SHA256 is used for the signature field content, signature = signature value which is signed with the specified algorithms and encoded with URL Safe base 64. To proof the callback integrity a client can use the official published NDID Proxy public key with the signature value.",
            "type": "string",
            "example": "keyId=��,algorithms=�rs256�,signature=�"
        }
    },
    "required": [
        "proxyReferenceId",
        "ndidRequestId",
        "notificationNdidStatus",
        "signature"
    ]
}
              

IdentityProviderVerificationResults

{
    "properties": {
        "identityProviderId": {
            "description": "Identity Provider ID",
            "type": "string",
            "example": "IdP1"
        },
        "status": {
            "description": "Possible value: accept, reject",
            "type": "string",
            "example": "accept"
        },
        "minAuthenticationAssuranceLevel": {
            "description": "Minimum authentication assurance level that Identity Provider can provide.",
            "type": "number",
            "format": "double",
            "example": "2.2"
        },
        "minIdentityAssuranceLevel": {
            "description": "Minimum identity assurance level that Identity Provider can provide.",
            "type": "number",
            "format": "double",
            "example": "2.3"
        },
        "errorCode": {
            "description": "Error Code for IdP",
            "type": "integer",
            "format": "int32",
            "example": "1"
        },
        "errorDescription": {
            "description": "Error Description for IdP",
            "type": "string",
            "example": "Error Description"
        }
    },
    "required": [
        "idpId"
    ]
}
              

AuthoritativeServiceResults

{
    "properties": {
        "serviceId": {
            "description": "Service ID",
            "type": "string",
            "example": "001.cust_inf_001, '002.credit_info_001"
        },
        "authoritativeServices": {
            "type": "array",
            "items": {
                "$ref": "#/definitions/AuthoritativeServices"
            }
        }
    },
    "required": [
        "serviceId"
    ]
}
              

AuthoritativeServices

{
    "properties": {
        "nodeId": {
            "description": "Authoritative Service ID",
            "type": "string",
            "example": "as1"
        },
        "receivedDataFlag": {
            "description": "Indicator of Received Data",
            "type": "boolean",
            "example": "True"
        },
        "signedFlag": {
            "description": "Indicator of Signed Received Data",
            "type": "boolean",
            "example": "True"
        },
        "errorCode": {
            "description": "Error Code for AS",
            "type": "integer",
            "format": "int32",
            "example": "1"
        },
        "errorDescription": {
            "description": "Error Description for AS",
            "type": "string",
            "example": "Error Description"
        }
    },
    "required": [
        "nodeId"
    ]
}
              

ErrorResponse

{
    "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"
    ]
}