INinterlace
Customer

Get customer profile

Retrieves the specified customer profile together with Scan-to-Pay transaction-country activation statuses.

For the response structure, see the Customer Profile Resource.

get/open-api/v3/scan2pay/customer/profile/{customerId}

Request

  • Base URL
    https://api-sandbox.interlace.money
  • URL
    https://api-sandbox.interlace.money/open-api/v3/scan2pay/customer/profile/{customerId}
  • Auth
    API key in header x-access-token

Path parameters

customerIdstring required

Interlace customer identifier

Response

Successful operation

codestring

Business code, 000000 means success

messagestring

Message description

Example response

{
  "code": "000000",
  "message": "success",
  "data": {
    "customer": {
      "customerId": "1986466477083709441",
      "customerEmail": "john.smith@example.com",
      "version": "v3",
      "firstName": "John",
      "lastName": "Smith",
      "dateOfBirth": "1990-01-01",
      "gender": "M",
      "nationality": "US",
      "nationalId": "A123456789",
      "idType": "PASSPORT",
      "issueDate": "2018-05-10",
      "expiryDate": "2028-05-10",
      "nationalAddress": {
        "addressLine1": "123 Main St",
        "addressLine2": "Apt 4B",
        "city": "New York",
        "country": "US",
        "postalCode": "10001"
      },
      "mailAddress": {
        "addressLine1": "123 Main St",
        "addressLine2": "Apt 4B",
        "city": "New York",
        "country": "US",
        "postalCode": "10001"
      },
      "frontImageId": "2046061141584039936",
      "backImageId": "2046061141584039936",
      "holdImageId": "2046061141584039936",
      "ipAddress": "192.168.1.1",
      "phoneNumber": "6505551234",
      "phoneCountryCode": "1",
      "occupation": "EMPLOYEE"
    },
    "countryActivations": [
      {
        "transactionCountry": "VN",
        "status": "SUCCESS",
        "errorMessage": "Insufficient documentation provided.",
        "missingMaterials": [
          {
            "fieldName": "frontImageId",
            "description": "Front ID image is blurred",
            "issueType": "INVALID",
            "suggestedAction": "REUPLOAD"
          }
        ]
      }
    ]
  }
}

Changes

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