Get Contact

GET

/api/v1/contact/{contactCode}

Retrieve a specific contact by its contact code (including address and beneficiary account).

Request

Authorization

JWT Bearer

Add the parameter

Authorization

to Headers

Example:

Authorization: ********************

Path Params

Responses

🟢200

application/json

Contact retrieved successfully

Bodyapplication/json

🟠404

🔴500Error

Request Example

Shell

JavaScript

Java

Swift

curl --location '/api/v1/contact/' \
--header 'Authorization: Bearer <token>'

Response Example

200 - Example 1

{
    "code": 200,
    "message": "success",
    "data": {
        "contactCode": "string",
        "contactType": "string",
        "businessType": "string",
        "displayName": "string",
        "nickname": "string",
        "companyName": "string",
        "firstName": "string",
        "lastName": "string",
        "email": "string",
        "phone": "string",
        "countryCode": "string",
        "nationality": "string",
        "status": "string",
        "verificationStatus": "string",
        "isFrequent": 0,
        "createTimeUtc": "2019-08-24",
        "updateTimeUtc": "2019-08-24",
        "paymentContactAddress": {
            "addressType": "string",
            "countryCode": "string",
            "state": "string",
            "city": "string",
            "streetAddress": "string",
            "postalCode": "string",
            "createTimeUtc": "2019-08-24",
            "updateTimeUtc": "2019-08-24"
        },
        "paymentContactAccount": {
            "accountType": "string",
            "paymentMethod": "string",
            "accountHolder": "string",
            "accountCurrencyCode": "string",
            "bankName": "string",
            "bankCountryCode": "string",
            "bankAddress": "string",
            "accountNumber": "string",
            "iban": "string",
            "swiftCode": "string",
            "walletNetwork": "string",
            "walletAddress": "string",
            "walletTag": "string",
            "clearingSystem": "string",
            "isDefault": 0,
            "status": "string",
            "createTimeUtc": "2019-08-24",
            "updateTimeUtc": "2019-08-24",
            "paymentContactAccountField": {
                "fieldKey": "string",
                "fieldValue": "string",
                "fieldLabel": "string",
                "fieldGroup": "string",
                "sort": 0,
                "isRequired": 0,
                "createTimeUtc": "2019-08-24",
                "updateTimeUtc": "2019-08-24"
            }
        }
    }
}

Modified at 2026-05-27 09:47:15

List Contacts

Count Contacts