Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Next »

This API is used to create an EKYC Request in order to use the EKYC and it will check whether the requester has the authorization to use the provided EKYC solution.

Request EKYC API will provide a successful result with a unique EKYC Request Id and encrypted Html page content based on the EKYC Provider.

 

API

/api/v1/request

Authorization

 Bearer Token

Method

POST

Headers

Content-Type:application/json

Payload

{
  "channel": "BRANCH",
  "agentLocationId": "784101",
  "ekycProvider": "EFR",
  "ecrn": "123456789",
  "primaryMobileNumber": "+971502106707",
  "emailId": "irfanmtp1@gmail.com"
}

Success Response

{
    "status": "success",
    "statusCode": 200,
    "data": {
        "ekyc_request_id": "4e41d40a-6f16-4874-977b-017798d1e583",
        "ekyc_request_data": {
            "ekyc_portal_html": "<<encrypted_base_64_ekyc_portal_html_if_any>>"
        }
    }
}

Authentication Failure

{
  "timestamp": "2022-12-05T13:44:31.557+00:00",
  "status": 401,
  "error": "Unauthorized",
  "path": "/api/v1/request"
}

Other Failure Response

{
  "status": "failure",
  "statusCode": 400,
  "errorCode": 40000,
  "message": "Payload not readable or corrupt"
}

 

Header

Name

Data Type

Max Length

Mandatory

Description

Content-Type

String

36

Yes

Content type

 

Payload

Name

Data Type

Max Length

Mandatory

Description

channel

String

20

Yes

Channel

agentLocationId

String

6

Yes

Unique Identifier to identify the requester

ekycProvider

String

30

Yes

EKYC Provider

ecrn

String

255

Yes

Customer Number

primaryMobileNumber

String

20

No

Primary Mobile Number

emailId

String

120

No

Email ID

 

Response

Name

Data Type

Max Length

Description

Name

Data Type

Max Length

Description

status

String

255

status description

status_code

Int

 -

Status code

message

String

255

Message

data

Object

-

Data object

ekyc_request_id

String

50

EKYC Request unique identification number

ekyc_request_data

Object

-

Data object

ekyc_portal_html

String

4000

Base 64 Encrypted EKYC Portal Html content

 

  • No labels