Confirm Upload

Confirm that all required documents have been uploaded and provide user details to start the certificate registration process. The additional details passed in this API will be stored and used during submission processing.

put/esign-partner/v1/submissions/urls

Request

  • Base URL
    https://onekyc.ky.id.sandbox.gopayapi.com
  • URL
    https://onekyc.ky.id.sandbox.gopayapi.com/esign-partner/v1/submissions/urls
  • Auth
    none declared. Required headers: x-onekyc-token, x-esign-onboarding-partner, x-partner-user-id, x-partner-user-id-type, x-partner-session-id

Headers

x-onekyc-tokenstring required

OneKYC Partner token generated using the Get Partner Token API

x-esign-onboarding-partnerstring required

Used to identify the source of the request (generated by OneKYC team)

x-partner-user-idstring required

User ID of the current session. OneKYC will tie this info to the resulting submission ID

x-partner-user-id-typestring required

Detailed name of the User ID. OneKYC will tie this info to the resulting submission ID

x-partner-session-idstring required

Session ID (generated by partner) used as correlation ID between partner and OneKYC. Must be unique for each invocation

Request body

submissionIdstring uuid required

Unique identification of submission record

Example request

{
  "metadata": {
    "userDetails": {
      "nik": 3177734902845410,
      "name": "John Doe",
      "dateOfBirth": "21-05-1980",
      "phoneNumber": "+6281234567890",
      "email": "user@example.com"
    },
    "userLocale": "en_ID",
    "consentData": [
      {
        "entity": "Digi",
        "consentType": "termsAndConditions",
        "consentGiven": true,
        "details": {
          "en_ID": {
            "url": "https://www.digi.com/termsAndConditions?version=v1.0.0",
            "text": "terms and conditions"
          },
          "id_ID": {
            "url": "https://www.digi.com/termsAndConditions?version=v1.0.0",
            "text": "terms and conditions"
          }
        },
        "timeStamp": 1725603017345,
        "additionalDetails": {
          "userAgent": "Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36",
          "userIp": "172.217.22.14",
          "deviceDetails": {
            "os": "R",
            "make": "google",
            "model": "KB2001",
            "uniqueId": "AF7KI0bly3aPIsYJ4+O+2QE",
            "networkProvider": "IND idea",
            "appId": "gojek",
            "appVersion": "4.96.0"
          }
        }
      }
    ]
  }
}

Response

Upload confirmed successfully

successboolean

Example response

{
  "success": true
}

Changes

No recorded changes to this operation across all 1 revision of this API.