PEpeakaccount
Contacts

Get Contact

Changed on
get/api/v1/Contacts

Request

Query parameters

taxIdstring

Tax Identification Number (TIN) of the contact to retrieve

branchCodestring

Branch code of the contact to retrieve, used together with taxId

codestring

Numeric code indicating whether the result data is returned in the response

idstring

The Unique Identifier generated by PEAK to identify data

limitinteger

Maximum number of entries to retrieve

pageinteger

Page number for displaying data, where each page will show 10 entries

getResult0 | 1

Numeric code indicating whether the result data is returned in the response

Headers

Time-Stampstring required

Timestamp (yyyyMMddHHmmss)

Time-Signaturestring required

HMAC-SHA1 encrypted Time-Stamp where Secret Key is connectId

User-Tokenstring required

This token will be generated by PEAK.

Client-Tokenstring required

Token used to identify between client and PEAK to call API.

Response

Success

eventTypestring
apiTypestring

Changes

  • 433c913c750fRevision changes
    • breaking

      the query request parameter getResult was restricted to a list of enum values

    • info

      added the new enum value 0.00 to the query request parameter getResult

    • info

      added the new enum value 1.00 to the query request parameter getResult

    • info

      added the optional property /// to the response with the status