---
swagger: "2.0"
info:
  description: This service is used for customer authentication / eKYC using biometrics
    verification.<br/>PCF Deployment Reference name -->  Auth-O-PartyAuth-BIO-DGL-EA<br/>
  version: 1.7.99
  x-ibm-name: PartyAuthentication_Biometric_Digital_Orchestration
  title: PartyAuthentication_Biometric_Digital_Orchestration
host: 127.0.0.1
schemes:
- https
basePath: /openapi
produces:
- application/json
paths:
  /v1/partyAuthentication/biometric/facialRecognition:
    post:
      summary: This API is used to do Live body detection with CFCA in china
      description: This API is used to do Live body detection with CFCA in china
      operationId: AuthorizePartyAuthenticationAssessmentBiometricFacialRecognition
      tags:
      - VerificationsAndAuthorizations
      parameters:
      - name: Authorization
        in: header
        description: 'The most recent Authorization token. This will have the format
          Bearer + {space} + {accessToken}. Example: Bearer KGNsaWVudF9pZDpjbGllbnRfc2VjcmV0KQ==.'
        type: string
        required: true
      - name: uuid
        in: header
        description: 128 bit random UUID generated uniquely for every request.
        type: string
        required: true
      - name: Accept
        in: header
        description: Content-Type that are acceptable for the response.
        type: string
        required: true
      - name: client_id
        in: header
        description: Client ID generated during application registration.
        required: true
        type: string
      - name: Content-Type
        in: header
        description: application/json
        required: true
        type: string
      - name: clientDetails
        in: header
        description: 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
        type: string
        required: false
      - name: AuthorizePartyAuthenticationAssessmentBiometricFacialRecognitionRequest
        in: body
        description: AuthorizePartyAuthenticationAssessmentBiometricFacialRecognitionRequest
        required: true
        schema:
          $ref: '#/definitions/AuthorizePartyAuthenticationAssessmentBiometricFacialRecognitionRequest'
      responses:
        200:
          description: Successful operation.
        400:
          description: <table><tr><td>Type</td><td>Code</td><td>Details</td></tr><tr><td>invalid</td><td>invalidRequest</td><td>Missing
            or invalid Parameters</td></tr><tr><td>error</td><td>authenticationFailed</td><td>Authentication
            failed</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
        401:
          description: <table><tr><td>Type</td><td>Code</td><td>Details</td></tr><tr><td>error</td><td>unAuthorized</td><td>Authorization
            credentials are missing or invalid</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
        403:
          description: <table><tr><td>Type</td><td>Code</td><td>Details</td></tr><tr><td>error</td><td>accessNotConfigured</td><td>The
            request operation is not configured to access this resource</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
        404:
          description: <table><tr><td>error</td><td>resourceNotFound</td><td>Empty
            resource/resource not found</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
        422:
          description: <table><tr><td>Type</td><td>Code</td><td>Details</td></tr><tr><td>error</td><td>businessValidationsFailed</td><td>Business
            validations failed</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
        500:
          description: <table><tr><td>Type</td><td>Code</td><td>Details</td></tr><tr><td>fatal</td><td>serverUnavailable</td><td>The
            request failed due to an internal error</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
  /v1/partyAuthentication/initialization:
    post:
      summary: Initialize biometrics verification flow.
      description: This API is used to initialize biometrics verification flow.
      tags:
      - VerificationsAndAuthorizations
      parameters:
      - name: Authorization
        in: header
        description: 'The most recent Authorization token. This will have the format
          Bearer + {space} + {accessToken}. Example: Bearer KGNsaWVudF9pZDpjbGllbnRfc2VjcmV0KQ==.'
        required: true
        type: string
      - name: uuid
        in: header
        description: 128 bit random UUID generated uniquely for every request.
        type: string
        required: true
      - name: Accept
        in: header
        description: Content-Type that are acceptable for the response.
        type: string
        required: true
      - name: client_id
        in: header
        description: The client ID  you received during application registration in
          the developer portal
        type: string
        required: true
      - name: Content-Type
        in: header
        description: application/json
        required: true
        type: string
      - name: clientDetails
        in: header
        description: 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
        type: string
        required: false
      - name: RequestPartyAuthenticationAssessmentInitializationRequest
        in: body
        description: Request data of biometrics verification initialization
        required: true
        schema:
          $ref: '#/definitions/RequestPartyAuthenticationAssessmentInitializationRequest'
      responses:
        200:
          description: Successful operation.
          schema:
            $ref: '#/definitions/RequestPartyAuthenticationAssessmentInitializationResponse'
        400:
          description: <table><tr><td>Type</td><td>Code</td><td>Details</td></tr><tr><td>invalid</td><td>invalidRequest</td><td>Missing
            or invalid Parameters</td></tr><tr><td>error</td><td>invalidControlFlowId</td><td>Control
            flow ID is invalid</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
        401:
          description: <table><tr><td>Type</td><td>Code</td><td>Details</td></tr><tr><td>error</td><td>unAuthorized</td><td>Authorization
            credentials are missing or invalid</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
        403:
          description: <table><tr><td>Type</td><td>Code</td><td>Details</td></tr><tr><td>error</td><td>accessNotConfigured</td><td>The
            request operation is not configured to access this resource</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
        404:
          description: <table><tr><td>Type</td><td>Code</td><td>Details</td></tr><tr><td>error</td><td>resourceNotFound</td><td>Empty
            resource/resource not found</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
        422:
          description: <table><tr><td>Type</td><td>Code</td><td>Details</td></tr><tr><td>error</td><td>businessValidationsFailed</td><td>Business
            validations failed</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
        500:
          description: <table><tr><td>Type</td><td>Code</td><td>Details</td></tr><tr><td>fatal</td><td>serverUnavailable</td><td>The
            request failed due to an internal error</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
  /v1/partyAuthentication/documents/identification/initialization:
    post:
      summary: Initialize biometrics identification document verification.
      description: This API is used to initialize biometrics identification document
        verification.
      operationId: RequestPartyAuthenticationAssessmentDocumentIdentificationInitialization
      tags:
      - VerificationsAndAuthorizations
      parameters:
      - name: Authorization
        in: header
        description: 'The most recent Authorization token. This will have the format
          Bearer + {space} + {accessToken}. Example: Bearer KGNsaWVudF9pZDpjbGllbnRfc2VjcmV0KQ==.'
        required: true
        type: string
      - name: uuid
        in: header
        description: 128 bit random UUID generated uniquely for every request.
        type: string
        required: true
      - name: Accept
        in: header
        description: Content-Type that are acceptable for the response.
        type: string
        required: true
      - name: client_id
        in: header
        description: The client ID  you received during application registration in
          the developer portal
        type: string
        required: true
      - name: Content-Type
        in: header
        description: application/json
        required: true
        type: string
      - name: clientDetails
        in: header
        description: 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
        type: string
        required: false
      - name: RequestPartyAuthenticationAssessmentDocumentIdentificationInitializationRequest
        in: body
        description: RequestPartyAuthenticationAssessmentDocumentIdentificationInitializationRequest
        required: true
        schema:
          $ref: '#/definitions/RequestPartyAuthenticationAssessmentDocumentIdentificationInitializationRequest'
      responses:
        200:
          description: Successful operation.
          schema:
            $ref: '#/definitions/RequestPartyAuthenticationAssessmentDocumentIdentificationInitializationResponse'
        400:
          description: <table><tr><td>Type</td><td>Code</td><td>Details</td></tr><tr><td>invalid</td><td>invalidRequest</td><td>Missing
            or invalid Parameters</td></tr><tr><td>error</td><td>invalidControlFlowId</td><td>Control
            flow ID is invalid</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
        401:
          description: <table><tr><td>Type</td><td>Code</td><td>Details</td></tr><tr><td>error</td><td>unAuthorized</td><td>Authorization
            credentials are missing or invalid</td></tr><tr><td>error</td><td>signatureInvalid</td><td>Invalid
            signature</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
        403:
          description: <table><tr><td>Type</td><td>Code</td><td>Details</td></tr><tr><td>error</td><td>accessNotConfigured</td><td>The
            request operation is not configured to access this resource</td></tr><tr><td>error</td><td>requestTrafficExceedsLimit</td><td>Request
            traffic exceeds limit</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
        404:
          description: <table><tr><td>Type</td><td>Code</td><td>Details</td></tr><tr><td>error</td><td>resourceNotFound</td><td>Empty
            resource/resource not found</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
        422:
          description: <table><tr><td>Type</td><td>Code</td><td>Details</td></tr><tr><td>error</td><td>businessValidationsFailed</td><td>Business
            validations failed</td></tr><tr><td>error</td><td>highRiskCase</td><td>High
            risk case</td></tr><tr><td>error</td><td>invalidEkycUniqueId</td><td>Invalid
            eKyc unique ID</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
        500:
          description: <table><tr><td>Type</td><td>Code</td><td>Details</td></tr><tr><td>fatal</td><td>serverUnavailable</td><td>The
            request failed due to an internal error</td></tr><tr><td>fatal</td><td>processFailed</td><td>Process
            failed</td></tr><tr><td>fatal</td><td>processTimeout</td><td>Process timeout</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
  /v1/partyAuthentication/documents/identification/results/retrieve:
    post:
      summary: Retrieve the results of identification document verification from vendor.
      description: This API is used to retrieve the results of identification document
        verification from vendor.
      tags:
      - VerificationsAndAuthorizations
      parameters:
      - name: Authorization
        in: header
        description: 'The most recent Authorization token. This will have the format
          Bearer + {space} + {accessToken}. Example: Bearer KGNsaWVudF9pZDpjbGllbnRfc2VjcmV0KQ==.'
        required: true
        type: string
      - name: uuid
        in: header
        description: 128 bit random UUID generated uniquely for every request.
        type: string
        required: true
      - name: Accept
        in: header
        description: Content-Type that are acceptable for the response.
        type: string
        required: true
      - name: client_id
        in: header
        description: The client ID  you received during application registration in
          the developer portal
        type: string
        required: true
      - name: Content-Type
        in: header
        description: application/json
        required: true
        type: string
      - name: clientDetails
        in: header
        description: 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
        type: string
        required: false
      - name: RetrievePartyAuthenticationAssessmentDocumentIdentificationResultsRequest
        in: body
        description: Request data of biometrics identification document verification
          result
        required: true
        schema:
          $ref: '#/definitions/RetrievePartyAuthenticationAssessmentDocumentIdentificationResultsRequest'
      responses:
        200:
          description: Successful operation.
          schema:
            $ref: '#/definitions/RetrievePartyAuthenticationAssessmentDocumentIdentificationResultsResponse'
        400:
          description: <table><tr><td>Type</td><td>Code</td><td>Details</td></tr><tr><td>invalid</td><td>invalidRequest</td><td>Missing
            or invalid Parameters</td></tr><tr><td>error</td><td>invalidControlFlowId</td><td>Control
            flow ID is invalid</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
        401:
          description: <table><tr><td>Type</td><td>Code</td><td>Details</td></tr><tr><td>error</td><td>unAuthorized</td><td>Authorization
            credentials are missing or invalid</td></tr><tr><td>error</td><td>signatureInvalid</td><td>Invalid
            signature</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
        403:
          description: <table><tr><td>Type</td><td>Code</td><td>Details</td></tr><tr><td>error</td><td>accessNotConfigured</td><td>The
            request operation is not configured to access this resource</td></tr><tr><td>error</td><td>requestTrafficExceedsLimit
            </td><td>Request traffic exceeds limit </td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
        404:
          description: <table><tr><td>Type</td><td>Code</td><td>Details</td></tr><tr><td>error</td><td>resourceNotFound</td><td>Empty
            resource/resource not found</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
        422:
          description: <table><tr><td>Type</td><td>Code</td><td>Details</td></tr><tr><td>error</td><td>businessValidationsFailed</td><td>Business
            validations failed</td></tr><tr><td>error</td><td>processNotFinished</td><td>Process
            has not been finished yet</td></tr><tr><td>error</td><td>invalidEkycUniqueId</td><td>Invalid
            eKyc unique ID</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
        500:
          description: <table><tr><td>Type</td><td>Code</td><td>Details</td></tr><tr><td>fatal</td><td>serverUnavailable</td><td>The
            request failed due to an internal error</td></tr><tr><td>fatal</td><td>processFailed</td><td>Process
            failed</td></tr><tr><td>fatal</td><td>processTimeout</td><td>Process timeout</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
  /v1/partyAuthentication/biometrics/faceCapture/initialization:
    post:
      summary: Initialize biometrics liveness verification.
      description: This API is used to initialize biometrics liveness verification.
      tags:
      - VerificationsAndAuthorizations
      parameters:
      - name: Authorization
        in: header
        description: 'The most recent Authorization token. This will have the format
          Bearer + {space} + {accessToken}. Example: Bearer KGNsaWVudF9pZDpjbGllbnRfc2VjcmV0KQ==.'
        required: true
        type: string
      - name: uuid
        in: header
        description: 128 bit random UUID generated uniquely for every request.
        type: string
        required: true
      - name: Accept
        in: header
        description: Content-Type that are acceptable for the response.
        type: string
        required: true
      - name: client_id
        in: header
        description: The client ID  you received during application registration in
          the developer portal
        type: string
        required: true
      - name: Content-Type
        in: header
        description: application/json
        required: true
        type: string
      - name: clientDetails
        in: header
        description: 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
        type: string
        required: false
      - name: RequestPartyAuthenticationAssessmentBiometricFaceCaptureInitializationRequest
        in: body
        description: Request data of biometrics liveness verification initialization
        required: true
        schema:
          $ref: '#/definitions/RequestPartyAuthenticationAssessmentBiometricFaceCaptureInitializationRequest'
      responses:
        200:
          description: Successful operation.
          schema:
            $ref: '#/definitions/RequestPartyAuthenticationAssessmentBiometricFaceCaptureInitializationResponse'
        400:
          description: <table><tr><td>Type</td><td>Code</td><td>Details</td></tr><tr><td>invalid</td><td>invalidRequest</td><td>Missing
            or invalid Parameters</td></tr><tr><td>error</td><td>invalidControlFlowId</td><td>Control
            flow ID is invalid</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
        401:
          description: <table><tr><td>Type</td><td>Code</td><td>Details</td></tr><tr><td>error</td><td>unAuthorized</td><td>Authorization
            credentials are missing or invalid</td></tr><tr><td>error</td><td>signatureInvalid</td><td>Invalid
            signature</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
        403:
          description: <table><tr><td>Type</td><td>Code</td><td>Details</td></tr><tr><td>error</td><td>accessNotConfigured</td><td>The
            request operation is not configured to access this resource</td></tr><tr><td>error</td><td>requestTrafficExceedsLimit</td><td>Request
            traffic exceeds limit</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
        404:
          description: <table><tr><td>Type</td><td>Code</td><td>Details</td></tr><tr><td>error</td><td>resourceNotFound</td><td>Empty
            resource/resource not found</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
        422:
          description: <table><tr><td>Type</td><td>Code</td><td>Details</td></tr><tr><td>error</td><td>businessValidationsFailed</td><td>Business
            validations failed</td></tr><tr><td>error</td><td>highRiskCase</td><td>High
            risk case</td></tr><tr><td>error</td><td>invalidEkycUniqueId</td><td>Invalid
            eKyc unique ID</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
        500:
          description: <table><tr><td>Type</td><td>Code</td><td>Details</td></tr><tr><td>fatal</td><td>serverUnavailable</td><td>The
            request failed due to an internal error</td></tr><tr><td>fatal</td><td>processFailed</td><td>Process
            failed</td></tr><tr><td>fatal</td><td>processTimeout</td><td>Process timeout</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
  /v1/partyAuthentication/biometrics/faceCapture/results/retrieve:
    post:
      summary: Retrieve the results of face recognition and liveness check from vendor.
      description: This API is used to retrieve the results of face recognition and
        liveness check from vendor.
      tags:
      - VerificationsAndAuthorizations
      parameters:
      - name: Authorization
        in: header
        description: 'The most recent Authorization token. This will have the format
          Bearer + {space} + {accessToken}. Example: Bearer KGNsaWVudF9pZDpjbGllbnRfc2VjcmV0KQ==.'
        required: true
        type: string
      - name: uuid
        in: header
        description: 128 bit random UUID generated uniquely for every request.
        type: string
        required: true
      - name: Accept
        in: header
        description: Content-Type that are acceptable for the response.
        type: string
        required: true
      - name: client_id
        in: header
        description: The client ID  you received during application registration in
          the developer portal
        type: string
        required: true
      - name: Content-Type
        in: header
        description: application/json
        required: true
        type: string
      - name: clientDetails
        in: header
        description: 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
        type: string
        required: false
      - name: RetrievePartyAuthenticationAssessmentBiometricFaceCaptureResultsRequest
        in: body
        description: Request data of biometrics liveness verification result
        required: true
        schema:
          $ref: '#/definitions/RetrievePartyAuthenticationAssessmentBiometricFaceCaptureResultsRequest'
      responses:
        200:
          description: Successful operation.
          schema:
            $ref: '#/definitions/RetrievePartyAuthenticationAssessmentBiometricFaceCaptureResultsResponse'
        400:
          description: <table><tr><td>Type</td><td>Code</td><td>Details</td></tr><tr><td>invalid</td><td>invalidRequest</td><td>Missing
            or invalid Parameters</td></tr><tr><td>error</td><td>invalidControlFlowId</td><td>Control
            flow ID is invalid</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
        401:
          description: <table><tr><td>Type</td><td>Code</td><td>Details</td></tr><tr><td>error</td><td>unAuthorized</td><td>Authorization
            credentials are missing or invalid</td></tr><tr><td>error</td><td>signatureInvalid</td><td>Invalid
            signature</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
        403:
          description: <table><tr><td>Type</td><td>Code</td><td>Details</td></tr><tr><td>error</td><td>accessNotConfigured</td><td>The
            request operation is not configured to access this resource</td></tr><tr><td>error</td><td>requestTrafficExceedsLimit</td><td>Request
            traffic exceeds limit</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
        404:
          description: <table><tr><td>Type</td><td>Code</td><td>Details</td></tr><tr><td>error</td><td>resourceNotFound</td><td>Empty
            resource/resource not found</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
        422:
          description: <table><tr><td>Type</td><td>Code</td><td>Details</td></tr><tr><td>error</td><td>businessValidationsFailed</td><td>Business
            validations failed</td></tr><tr><td>error</td><td>processNotFinished</td><td>Process
            has not been finished yet</td></tr><tr><td>error</td><td>invalidEkycUniqueId</td><td>Invalid
            eKyc unique ID</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
        500:
          description: <table><tr><td>Type</td><td>Code</td><td>Details</td></tr><tr><td>fatal</td><td>serverUnavailable</td><td>The
            request failed due to an internal error</td></tr><tr><td>fatal</td><td>processFailed</td><td>Process
            failed</td></tr><tr><td>fatal</td><td>processTimeout</td><td>Process timeout</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
  /v1/partyAuthentication/faceComparison/risks:
    post:
      summary: Used to do the similarity comparison between the ID photo and self-photo
        of customer and perform risk check.
      description: This API is used to do the similarity comparison between the ID
        photo and self-photo of customer and perform risk check.
      operationId: BiometricsVerificationAdd
      tags:
      - VerificationsAndAuthorizations
      parameters:
      - name: Authorization
        in: header
        description: 'The most recent Authorization token. This will have the format
          Bearer + {space} + {accessToken}. Example: Bearer KGNsaWVudF9pZDpjbGllbnRfc2VjcmV0KQ==.'
        required: true
        type: string
      - name: uuid
        in: header
        description: 128 bit random UUID generated uniquely for every request.
        type: string
        required: true
      - name: Accept
        in: header
        description: Content-Type that are acceptable for the response.
        type: string
        required: true
      - name: client_id
        in: header
        description: The client ID  you received during application registration in
          the developer portal
        type: string
        required: true
      - name: Content-Type
        in: header
        description: application/json
        required: true
        type: string
      - name: clientDetails
        in: header
        description: 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
        type: string
        required: false
      - name: EvaluatePartyAuthenticationAssessmentFaceComparisonAndRiskRequest
        in: body
        description: Input data of biometrics verification add
        required: true
        schema:
          $ref: '#/definitions/EvaluatePartyAuthenticationAssessmentFaceComparisonAndRiskRequest'
      responses:
        200:
          description: Successful operation.
          schema:
            $ref: '#/definitions/EvaluatePartyAuthenticationAssessmentFaceComparisonAndRiskResponse'
        400:
          description: <table><tr><td>Type</td><td>Code</td><td>Details</td></tr><tr><td>invalid</td><td>invalidRequest</td><td>Missing
            or invalid Parameters</td></tr><tr><td>invalid</td><td>unableToProcessImage</td><td>Unable
            to process the image</td></tr><tr><td>error</td><td>invalidControlFlowId</td><td>Control
            flow ID is invalid</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
        401:
          description: <table><tr><td>Type</td><td>Code</td><td>Details</td></tr><tr><td>error</td><td>unAuthorized</td><td>Authorization
            credentials are missing or invalid</td></tr><tr><td>error</td><td>signatureInvalid</td><td>Invalid
            signature</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
        403:
          description: <table><tr><td>Type</td><td>Code</td><td>Details</td></tr><tr><td>error</td><td>accessNotConfigured</td><td>The
            request operation is not configured to access this resource</td></tr><tr><td>error</td><td>requestTrafficExceedsLimit
            </td><td>Request traffic exceeds limit</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
        404:
          description: <table><tr><td>Type</td><td>Code</td><td>Details</td></tr><tr><td>error</td><td>resourceNotFound</td><td>Empty
            resource/resource not found</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
        422:
          description: <table><tr><td>Type</td><td>Code</td><td>Details</td></tr><tr><td>error</td><td>businessValidationsFailed</td><td>Business
            validations failed</td></tr><tr><td>error</td><td>invalidEkycUniqueId</td><td>Invalid
            eKyc unique ID</td></tr><tr><td>error</td><td>transactionNotFound</td><td>Transaction(s)
            not found</td></tr><tr><td>error</td><td>transactionNotValid</td><td>Transaction(s)
            not valid</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
        500:
          description: <table><tr><td>Type</td><td>Code</td><td>Details</td></tr><tr><td>fatal</td><td>serverUnavailable</td><td>The
            request failed due to an internal error</td></tr><tr><td>fatal</td><td>processTimeout</td><td>Process
            timeout</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
  /v1/partyAuthentication/formattedApplicantInfo/retrieve:
    post:
      summary: Used to get the formatted (Citi Standard) customer personal information
        which is originally retrieved from biometrics verification results.
      description: This API is used to get the formatted (Citi Standard) customer
        personal information which is originally retrieved from biometrics verification
        results.
      tags:
      - VerificationsAndAuthorizations
      parameters:
      - name: Authorization
        in: header
        description: 'The most recent Authorization token. This will have the format
          Bearer + {space} + {accessToken}. Example: Bearer KGNsaWVudF9pZDpjbGllbnRfc2VjcmV0KQ==.'
        required: true
        type: string
      - name: uuid
        in: header
        description: 128 bit random UUID generated uniquely for every request.
        type: string
        required: true
      - name: Accept
        in: header
        description: Content-Type that are acceptable for the response.
        type: string
        required: true
      - name: client_id
        in: header
        description: The client ID  you received during application registration in
          the developer portal
        type: string
        required: true
      - name: Content-Type
        in: header
        description: application/json
        required: true
        type: string
      - name: clientDetails
        in: header
        description: 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
        type: string
        required: false
      - name: RetrievePartyAuthenticationAssessmentFormattedApplicantInfoRequest
        in: body
        description: Request data of fetch formatted applicant info from beonetrics
          verification results.
        required: true
        schema:
          $ref: '#/definitions/RetrievePartyAuthenticationAssessmentFormattedApplicantInfoRequest'
      responses:
        200:
          description: The request has succeeded
          schema:
            $ref: '#/definitions/RetrievePartyAuthenticationAssessmentFormattedApplicantInfoResponse'
        400:
          description: <table><tr><td>Type</td><td>Code</td><td>Details</td></tr><tr><td>invalid</td><td>invalidRequest</td><td>Missing
            or invalid Parameters</td></tr><tr><td>error</td><td>invalidControlFlowId</td><td>Control
            flow ID is invalid</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
        401:
          description: <table><tr><td>Type</td><td>Code</td><td>Details</td></tr><tr><td>error</td><td>unAuthorized</td><td>Authorization
            credentials are missing or invalid</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
        403:
          description: <table><tr><td>Type</td><td>Code</td><td>Details</td></tr><tr><td>error</td><td>accessNotConfigured</td><td>The
            request operation is not configured to access this resource</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
        404:
          description: <table><tr><td>Type</td><td>Code</td><td>Details</td></tr><tr><td>error</td><td>resourceNotFound</td><td>Empty
            resource/resource not found</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
        422:
          description: <table><tr><td>Type</td><td>Code</td><td>Details</td></tr><tr><td>error</td><td>businessValidationsFailed</td><td>Business
            validations failed</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
        500:
          description: <table><tr><td>fatal</td><td>serverUnavailable</td><td>The
            request failed due to an internal error</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
  /v1/partyAuthentication/identityProviders/retrieve:
    post:
      summary: To list identity providers (IdPs) that the user has registered before
        creating verification identity request.
      description: To list identity providers (IdPs) that the user has registered
        before creating verification identity request.
      operationId: RetrievePartyAuthenticationAssessmentIdentityProviders
      tags:
      - VerificationAndAuthorizations
      parameters:
      - name: Authorization
        in: header
        description: 'The most recent Authorization token. This will have the format
          Bearer + {space} + {accessToken}. Example: Bearer KGNsaWVudF9pZDpjbGllbnRfc2VjcmV0KQ==.'
        type: string
        required: true
      - name: uuid
        in: header
        description: 128 bit random universally unique identifier (UUID) generated
          for every request.
        type: string
        required: true
      - name: Accept
        in: header
        description: Content-Types that are acceptable for the response. Always pass
          application/json.
        type: string
        required: true
      - name: client_id
        in: header
        description: Client ID generated during application registration.
        required: true
        type: string
      - name: Content-Type
        in: header
        description: application/json.
        required: true
        type: string
      - name: clientDetails
        in: header
        description: 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.
        type: string
        required: false
      - name: RetrievePartyAuthenticationAssessmentIdentityProvidersRequest
        in: body
        description: RetrievePartyAuthenticationAssessmentIdentityProvidersRequest
        required: true
        schema:
          $ref: '#/definitions/RetrievePartyAuthenticationAssessmentIdentityProvidersRequest'
      responses:
        200:
          description: Successful operation.
          schema:
            $ref: '#/definitions/RetrievePartyAuthenticationAssessmentIdentityProvidersResponse'
        400:
          description: <table><tr><td>Type</td><td>Code</td><td>Details</td></tr><tr><td>invalid</td><td>invalidRequest</td><td>Missing
            or invalid parameters</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
        401:
          description: <table><tr><td>Type</td><td>Code</td><td>Details</td></tr><tr><td>error</td><td>unAuthorized</td><td>Authorization
            credential is missing or invalid</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
        403:
          description: <table><tr><td>Type</td><td>Code</td><td>Details</td></tr><tr><td>error</td><td>accessNotConfigured</td><td>Access
            is not configured for this resource</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
        404:
          description: <table> <tr><td>Type</td><td>Code</td><td>Details</td></tr><tr><td>error</td><td>resourceNotFound</td><td>Empty
            resource/resource not found</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
        422:
          description: <table><tr><td>Type</td><td>Code</td><td>Details</td></tr><tr><td>error</td><td>businessValidationsFailed</td><td>Business
            validations failed</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
        500:
          description: <table><tr><td>Type</td><td>Code</td><td>Details</td></tr><tr><td>fatal</td><td>serverUnavailable</td><td>The
            request failed due to an internal error</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
  /v1/partyAuthentication/identityProviders:
    post:
      summary: To evaluate Identity Provider verification
      description: Customer does transaction with client and needs to verify the identity
        with request data. The client will create verification identity request to
        the NDID proxy. This feature will have parameter as NDID platform to allow
        client to customize its request, the specific request with simplified parameter
      operationId: EvaluatePartyAuthenticationAssessmentIdentityProviders
      tags:
      - VerificationAndAuthorizations
      parameters:
      - name: Authorization
        in: header
        description: 'The most recent Authorization token. This will have the format
          Bearer + {space} + {accessToken}. Example: Bearer KGNsaWVudF9pZDpjbGllbnRfc2VjcmV0KQ==.'
        type: string
        required: true
      - name: uuid
        in: header
        description: 128 bit random universally unique identifier (UUID) generated
          for every request.
        type: string
        required: true
      - name: Accept
        in: header
        description: Content-Types that are acceptable for the response. Always pass
          application/json.
        type: string
        required: true
      - name: client_id
        in: header
        description: Client ID generated during application registration.
        required: true
        type: string
      - name: Content-Type
        in: header
        description: application/json.
        required: true
        type: string
      - name: clientDetails
        in: header
        description: 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.
        type: string
        required: false
      - name: EvaluatePartyAuthenticationAssessmentIdentityProvidersRequest
        in: body
        description: EvaluatePartyAuthenticationAssessmentIdentityProvidersRequest
        required: true
        schema:
          $ref: '#/definitions/EvaluatePartyAuthenticationAssessmentIdentityProvidersRequest'
      responses:
        200:
          description: Successful operation.
          schema:
            $ref: '#/definitions/EvaluatePartyAuthenticationAssessmentIdentityProvidersResponse'
        400:
          description: <table><tr><td>Type</td><td>Code</td><td>Details</td></tr><tr><td>invalid</td><td>invalidRequest</td><td>Missing
            or invalid parameters</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
        401:
          description: <table><tr><td>Type</td><td>Code</td><td>Details</td></tr><tr><td>error</td><td>unAuthorized</td><td>Authorization
            credentials are missing or invalid</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
        403:
          description: <table><tr><td>Type</td><td>Code</td><td>Details</td></tr><tr><td>error</td><td>accessNotConfigured</td><td>Access
            is not configured for this resource</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
        404:
          description: <table><tr><td>Type</td><td>Code</td><td>Details</td></tr><tr><td>error</td><td>resourceNotFound</td><td>Empty
            resource/resource not found</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
        422:
          description: <table><tr><td>Type</td><td>Code</td><td>Details</td></tr><tr><td>error</td><td>businessValidationsFailed</td><td>Business
            validations failed</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
        500:
          description: <table><tr><td>Type</td><td>Code</td><td>Details</td></tr><tr><td>fatal</td><td>serverUnavailable</td><td>The
            request failed due to an internal error</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
  /v1/partyAuthentication/ndid/notifications:
    post:
      summary: This API is used by third party channel (DAP) to notify ESB with IdP
        and AS response.
      description: This API is used by third party channel (DAP) to notify ESB with
        IdP and AS response.
      operationId: EvaluatePartyAuthenticationAssessmentNdidNotification
      tags:
      - VerificationAndAuthorizations
      parameters:
      - name: Authorization
        in: header
        description: 'The most recent Authorization token. This will have the format
          Bearer + {space} + {accessToken}. Example: Bearer KGNsaWVudF9pZDpjbGllbnRfc2VjcmV0KQ==.'
        type: string
        required: true
      - name: uuid
        in: header
        description: 128 bit random universally unique identifier (UUID) generated
          for every request.
        type: string
        required: true
      - name: Accept
        in: header
        description: Content-Types that are acceptable for the response. Always pass
          application/json.
        type: string
        required: true
      - name: client_id
        in: header
        description: Client ID generated during application registration.
        required: true
        type: string
      - name: Content-Type
        in: header
        description: application/json.
        required: true
        type: string
      - name: clientDetails
        in: header
        description: 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.
        type: string
        required: false
      - name: EvaluatePartyAuthenticationAssessmentNdidNotificationRequest
        in: body
        description: EvaluatePartyAuthenticationAssessmentNdidNotificationRequest
        required: true
        schema:
          $ref: '#/definitions/EvaluatePartyAuthenticationAssessmentNdidNotificationRequest'
      responses:
        200:
          description: Successful operation.
        400:
          description: <table><tr><td>Type</td><td>Code</td><td>Details</td></tr><tr><td>invalid</td><td>invalidRequest</td><td>Missing
            or invalid Parameters</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
        401:
          description: <table><tr><td>Type</td><td>Code</td><td>Details</td></tr><tr><td>error</td><td>unAuthorized</td><td>Authorization
            credentials are missing or invalid</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
        403:
          description: <table><tr><td>Type</td><td>Code</td><td>Details</td></tr><tr><td>error</td><td>accessNotConfigured</td><td>The
            request operation is not configured to access this resource</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
        404:
          description: <table><tr><td>Type</td><td>Code</td><td>Details</td></tr><tr><td>error</td><td>resourceNotFound</td><td>Empty
            resource/resource not found</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
        422:
          description: <table><tr><td>Type</td><td>Code</td><td>Details</td></tr><tr><td>error</td><td>businessValidationsFailed</td><td>Business
            validations failed</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
        500:
          description: <table><tr><td>Type</td><td>Code</td><td>Details</td></tr><tr><td>fatal</td><td>serverUnavailable</td><td>The
            request failed due to an internal error</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
definitions:
  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.615180
      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.200000
      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=�<keyId>�,algorithms=�rs256�,signature=�<URL_SAFE_BASE64(RSA-SHA256(body_content))>
    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
x-ibm-configuration:
  enforced: true
  testable: true
  phase: realized
securityDefinitions:
  api-key-1:
    type: apiKey
    description: ""
    in: header
    name: X-IBM-Client-Id
  oauth-1:
    type: oauth2
    description: ""
    flow: application
    scopes: []
    tokenUrl: https://aspac.sandbox.webapi.citigroup.net/gcbap/confidential/clientCredentials/oauth2/token/sg/gcb
    x-tokenIntrospect:
      url: https://aspac.sandbox.webapi.citigroup.net/gcbap/confidential/clientCredentials/oauth2/introspect
security:
- oauth-1: []
  api-key-1: []
x-ibm-endpoints:
- endpointUrl: https://aspac.sandbox.api.citi.com/gcbap
  description: Custom Gateway API Endpoint
  type:
  - production
  - development
...