After the Verification process is done , you can request the Profile.

Request Example:

curl -X POST \
  https://sg-api.advance.ai/intl/openapi/identity-risk/idvs-h5/ekyc/v1/get-by-external-user-id?externalUserId=xxx \
  -H 'Content-Type: application/json' \
  -H 'X-ACCESS-TOKEN:{Your Access Token}'

Request Url

https://sg-api.advance.ai/intl/openapi/identity-risk/idvs-h5/ekyc/v1/customer-profile/get-by-external-user-id?externalUserId=xxx
GET

https://api.advance.ai/intl/openapi/identity-risk/idvs-h5/ekyc/v1/customer-profile/getByExternalUserId?externalUserId=xxx
GET

Request Header Parameters

Parameter	Description
X-ACCESS-TOKEN	`string` Please use Token Authentication API to get your access token

Request Parameters

Parameter	Description
externalUserId	`string` the `userId` from Generate URL API's request

Response Description

Parameter	Description
code	Response's Status Code
transactionId	The request id, the max length is 64
pricingStrategy	`Deprecated`, Always return `FREE`
message	Status Code Explanation
data	`object` : the business result of Verification
extra	Extra response info (Exception Message)

Response.code

Status Code	Message
SUCCESS	OK
PARAMETER_ERROR	Invalid ID number, please check it
ERROR	Server error.

Response.data

Field	Description
status	`string`, `ACTIVE` or `INACTIVE`
documentInfos	`list`, the list of DocumentInfo. a docType may appear at most 1 times in the list. the latest docDetail shall be returned per docType. Refer to DocumentInfo
signatureIds	`list`, the list of the signatureId belongs to this user.

Field

Description

status

string, ACTIVE or INACTIVE

documentInfos

list, the list of DocumentInfo. a docType may appear at most 1 times in the list. the latest docDetail shall be returned per docType.

Refer to DocumentInfo

signatureIds

list, the list of the signatureId belongs to this user.

DocumentInfo

Field	Description
docType	`string`, Refer to Supported Regions & DocTypes
subDocType	`string`, Refer to Supported Regions & DocTypes
docDetail	`object`, Refer to DocDetail

Response Examples

SUCCESS

{
    "code": "SUCCESS",
    "message": "OK",
    "transactionId": "8bb2fdc4142bdcf3",
    "data": {
        "status": "ACTIVE",
        "documentInfos": [
            {
                "docType": "ID-ID-KTP",
                "subDocType": "ID-ID-KTP",
                "docDetail": {
                        "front": {
                                "idNumber": "871125523500",
                                "documentNumber": null,
                                "fullName": "LEE SHI YIN",
                                "fullNameLocal": null,
                                "lastName": null,
                                "lastNameLocal": null,
                                "firstName": null,
                                "firstNameLocal": null,
                                "middleName": null,
                                "middleNameLocal": null,
                                "birthday": "1987/11/25",
                                "dobDay": null,
                                "dobMonth": null,
                                "dobYear": null,
                                "expiryDate": null,
                                "expiryDay": null,
                                "expiryMonth": null,
                                "expiryYear": null,
                                "daysToExpiry": null,
                                "issueDate": null,
                                "issueDay": null,
                                "issueMonth": null,
                                "issueYear": null,
                                "daysFromIssue": null,
                                "state": null,
                                "city": null,
                                "district": null,
                                "subdistrict": null,
                                "fullAddress": "NO 26 JALAN DUTA 3/5 TAMAN",
                                "postcode": null,
                                "placeOfBirth": null,
                                "issuerAuthority": null,
                                "issuerPlace": null,
                                "gender": "FEMALE",
                                "height": null,
                                "weight": null,
                                "eyeColor": null,
                                "bloodType": null,
                                "religion": "",
                                "nationality": null,
                                "issuerCountry": null,
                                "countryCode": null,
                                "passportType": null,
                                "vehicleClass": null,
                                "restrictions": null,
                                "endorsement": null,
                                "others": {},
                                "side": "front",
                                "genderLocal": "PEREMPUAN",
                                "nationalityLocal": null
                        },
                        "back": {
                                "idNumber": null,
                                "documentNumber": "8711567840000301",
                                "fullName": null,
                                "fullNameLocal": null,
                                "lastName": null,
                                "lastNameLocal": null,
                                "firstName": null,
                                "firstNameLocal": null,
                                "middleName": null,
                                "middleNameLocal": null,
                                "birthday": null,
                                "dobDay": null,
                                "dobMonth": null,
                                "dobYear": null,
                                "expiryDate": null,
                                "expiryDay": null,
                                "expiryMonth": null,
                                "expiryYear": null,
                                "daysToExpiry": null,
                                "issueDate": null,
                                "issueDay": null,
                                "issueMonth": null,
                                "issueYear": null,
                                "daysFromIssue": null,
                                "state": null,
                                "city": null,
                                "district": null,
                                "subdistrict": null,
                                "fullAddress": null,
                                "postcode": null,
                                "placeOfBirth": null,
                                "issuerAuthority": null,
                                "issuerPlace": null,
                                "gender": null,
                                "height": null,
                                "weight": null,
                                "eyeColor": null,
                                "bloodType": null,
                                "religion": null,
                                "nationality": null,
                                "issuerCountry": null,
                                "countryCode": null,
                                "passportType": null,
                                "vehicleClass": null,
                                "restrictions": null,
                                "endorsement": null,
                                "side": "back",
                                "others": {},
                                "genderLocal": "PEREMPUAN",
                                "nationalityLocal": null
                        }
                }
            }],
        "signatureIds": ["8bb2fdc4142bdcf3", "8bb2fdc4142bdcf4", "8bb2fdc4142bdcf5"]
    }
}

PARAMETER_ERROR

{
 "code": "PARAMETER_ERROR",
 "message": "externalUserId does not exist.",
 "data": null,
 "extra": null,
 "transactionId": "8bb2fdc4142bdcf3",
 "pricingStrategy": "FREE"
}

ERROR

{
    "code":"ERROR",
    "message":"Server error",
    "data":null,
    "extra":null,
    "transactionId":"1deae5a13ef2bd5e"
}