CREATEFACELIVENESSSESSION()`¶

About CreateFaceLivenessSession¶

This API operation initiates a Face Liveness session. It returns a SessionId, which you can use to start streaming Face Liveness video and get the results for a Face Liveness session.

You can use the OutputConfig option in the Settings parameter to provide an Amazon S3 bucket location. The Amazon S3 bucket stores reference images and audit images. If no Amazon S3 bucket is defined, raw bytes are sent instead.

You can use AuditImagesLimit to limit the number of audit images returned when GetFaceLivenessSessionResults is called. This number is between 0 and 4. By default, it is set to 0. The limit is best effort and based on the duration of the selfie-video.

Method Signature¶

METHODS /AWS1/IF_REK~CREATEFACELIVENESSSESSION
  IMPORTING
    !IV_KMSKEYID TYPE /AWS1/REKKMSKEYID OPTIONAL
    !IO_SETTINGS TYPE REF TO /AWS1/CL_REKCREFACELIVENESSS01 OPTIONAL
    !IV_CLIENTREQUESTTOKEN TYPE /AWS1/REKCLIENTREQUESTTOKEN OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_rekcrefacelivenesss02
  RAISING
    /AWS1/CX_REKACCESSDENIEDEX
    /AWS1/CX_REKINTERNALSERVERERR
    /AWS1/CX_REKINVALIDPARAMETEREX
    /AWS1/CX_REKPROVTHRUPUTEXCDEX
    /AWS1/CX_REKTHROTTLINGEX
    /AWS1/CX_REKCLIENTEXC
    /AWS1/CX_REKSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Optional arguments:¶

`iv_kmskeyid` `TYPE /AWS1/REKKMSKEYID` `/AWS1/REKKMSKEYID`¶

The identifier for your AWS Key Management Service key (AWS KMS key). Used to encrypt audit images and reference images.

`io_settings` `TYPE REF TO /AWS1/CL_REKCREFACELIVENESSS01` `/AWS1/CL_REKCREFACELIVENESSS01`¶

A session settings object. It contains settings for the operation to be performed. For Face Liveness, it accepts OutputConfig and AuditImagesLimit.

`iv_clientrequesttoken` `TYPE /AWS1/REKCLIENTREQUESTTOKEN` `/AWS1/REKCLIENTREQUESTTOKEN`¶

Idempotent token is used to recognize the Face Liveness request. If the same token is used with multiple CreateFaceLivenessSession requests, the same session is returned. This token is employed to avoid unintentionally creating the same session multiple times.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_rekcrefacelivenesss02` `/AWS1/CL_REKCREFACELIVENESSS02`¶

Domain /AWS1/RT_ACCOUNT_ID

Primitive Type NUMC

Examples¶

Syntax Example¶

This is an example of the syntax for calling the method. It includes every possible argument and initializes every possible value. The data provided is not necessarily semantically accurate (for example the value "string" may be provided for something that is intended to be an instance ID, or in some cases two arguments may be mutually exclusive). The syntax shows the ABAP syntax for creating the various data structures.

DATA(lo_result) = lo_client->createfacelivenesssession(
  io_settings = new /aws1/cl_rekcrefacelivenesss01(
    io_outputconfig = new /aws1/cl_reklivenessoutputcfg(
      iv_s3bucket = |string|
      iv_s3keyprefix = |string|
    )
    it_challengepreferences = VALUE /aws1/cl_rekchallengeprefere00=>tt_challengepreferences(
      (
        new /aws1/cl_rekchallengeprefere00(
          io_versions = new /aws1/cl_rekversions(
            iv_maximum = |string|
            iv_minimum = |string|
          )
          iv_type = |string|
        )
      )
    )
    iv_auditimageslimit = 123
  )
  iv_clientrequesttoken = |string|
  iv_kmskeyid = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_livenesssessionid = lo_result->get_sessionid( ).
ENDIF.

/AWS1/IF_REK=>CREATEFACELIVENESSSESSION()¶