Nhảy tới nội dung

API to upload necessary images.

Request

  • Endpoint: /v1/api/ekyc-verify/upload

  • Method: POST

  • Header

    NameTypeRequiredDescription
    api_keystringyesThe API key associated with your account to authenticate requests (for development, check the Credentials section).
  • Parameters

    NameTypeRequiredDescription
    session_idstringyesCurrent session ID.
    image_typestring (enum)yes

    Supported image types:

    • ID card front image: idcard
    • ID card back image: back_idcard
    • Driver license front image: driver_license
    • Passport front image: passport
    • Documentation front image (unknown type): front_id_doc
    • Documentation back image (unknown type): back_id_doc
    • Selfie image: selfie
    • Selfie image 1 for selfie vs selfie matching: base_selfie
    • Selfie image 2 for selfie vs selfie matching: query_selfie
    • QR image: qr
    uidstringnoUser ID.
    prod_idstringnoProduct ID.
    oa_idstringnoOA id which is used to encode uid
    app_idstringnoApp id which is used to encode uid
  • Body

    • Type: application/json

    • Data:

      NameTypeRequiredDescription
      image_bytesbinaryyesUploaded image.

Response

  • Status: 200 OK

  • Body: JSON

    {
    "code": 0,
    "message": "Successful",
    "data": "<ENCRYPTED_DATA_IN_BASE64>"
    }
    • Field “data”: Decrypt the “data” field as described in the Decrypt response data section to get the JSON object with following fields.

      NameTypeDescription
      photo_idnumberID of the uploaded image.