KYC Data Pull API

Description

This API returns KYC data for the latest submission against a linked user in case the KYC submission is successful.

Host

Staging

https://identity.staging.midtrans.com

No IP whitelisting

Production

https://identity.midtrans.com

IP whitelisted (Partner needs to provide)

Endpoint

/forward/gopay-id/kyc/inbound/v1/users/submissions/current

Method

GET

Headers

Header key	Description	Example
x-merchant-id	Pre-agreed value shared that identifies a partner	PARTNER-NAME
authorization	Linking token received after login step
correlation-id	A unique ID per request for debugging purposes

Response

HTTP 200 (Submission approved)

{
  "success": true,
  "data": {
    "status": "COMPLETED",
    "result": "VALID",
    "partner": "PARTNER-NAME",
    "onboardingPartner": "PARTNER-NAME-SDK-GOPAY_ID_KYC",
    "documents": [
      {
        "documentType": "SELFIE",
        "url": "http://link-to-download-image",
        "expiresAt": "2025-11-24T10:16:01.107963"
      },
      {
        "documentType": "KYC_PROOF",
        "url": "http://link-to-download-image",
        "expiresAt": "2025-11-24T10:16:01.111676"
      }
    ],
    "submissionData": {
      "ktp": {
        "name": "ABC SIMULATOR A",
        "dob": "1990-09-10",
        "birthPlace": "JAKARTA",
        "gender": "female",
        "documentNumber": "1234123412341234",
        "citizenship": "INDONESIA",
        "province": "DKI JAKARTA",
        "city": "JAKARTA SELATAN",
        "otherAddressDetails": "APT PS-1391 HENDRE",
        "subdistrict": "MANDAKAR",
        "village": "GORONTALO",
        "religion": "BUDHA",
        "maritalStatus": "CERAI MATI",
        "rw": "025",
        "rt": "004",
        "occupation": "ARTIS",
        "issuedAt": "2015-12-07"
      }
    },
    "createdAt": "2025-09-25T04:27:06.68818",
    "updatedAt": "2025-09-25T04:27:06.68818"
  }
}

HTTP 200 (Submission rejected)

{
  "success": true,
  "data": {
    "status": "COMPLETED",
    "result": "INVALID",
    "rejectionReason": "GOPAY_ID_REJECTED",
    "partner": "PARTNER-NAME",
    "onboardingPartner": "PARTNER-NAME-SDK-GOPAY_ID_KYC",
    "createdAt": "2025-09-25T04:27:06.68818",
    "updatedAt": "2025-09-25T04:27:06.68818"
  }
}

Currently, rejectionReason: GOPAY_ID_REJECTED will be the only value here.

HTTP 200 (Submission in progress)

{
  "success": true,
  "data": {
    "status": "IN_PROGRESS",
    "partner": "PARTNER-NAME",
    "onboardingPartner": "PARTNER-NAME-SDK-GOPAY_ID_KYC"
    "createdAt": "2025-09-25T04:27:06.68818",
    "updatedAt": "2025-09-25T04:27:06.68818"
  }
}

HTTP 200 (Submission initiated)

{
  "success": true,
  "data": {
    "status": "INITIATED",
    "partner": "PARTNER-NAME",
    "onboardingPartner": "PARTNER-NAME-SDK-GOPAY_ID_KYC"
    "createdAt": "2025-09-25T04:27:06.68818",
    "updatedAt": "2025-09-25T04:27:06.68818"
  }
}

HTTP 404 (Submission not found)

{
  "success": false,
  "errors": [
    {
      "cause": "SUBMISSION_NOT_FOUND"
    }
  ]
}

HTTP 500 (Internal server error)

{
  "success": false,
  "errors": [
    {
      "cause": "some_error_cause" // e.g. INTERNAL_SERVER_ERROR
    }
  ]
}