Validate Account

The validate account endpoint provides you with the ability to validate your credentials required to access the Decryptx API.

Request Path

POST /api/partner/validate

Request Object

The API consumes a JSON object with the following properties:

Property Type Description
partnerId String ID provided by Bluefin for access to the Decryptx API.
partnerKey String API Key provided by Bluefin for access to the Decryptx API. This value can be changed on request from the partner or by the partner via the Decryptx portal.
reference (optional) String A string (of up to 50 characters) that helps partners identify individual API calls. If provided, the value will be logged to the P2PE Manager where it can be used to troubleshoot technical issues. It is highly recommended that a unique value be used on each Decryptx API call. The reference value will be returned in the response body, whether the API call is successful or not.

Response Object

A successful API call outputs a JSON object with the following properties:

Property Type Description
success Boolean Indicates if the validation was successful or not.
reference String A string (of up to 50 characters) that helps partners identify individual API calls. If provided, the value will be logged to the P2PE Manager where it can be used to troubleshoot technical issues. It is highly recommended that a unique value be used on each Decryptx API call. The reference value will be returned in the response body, whether the API call is successful or not.
messageId String Bluefin assigned unique identifier for each response from the Decryptx API. This can and should be stored for troubleshooting purposes. This will be 25 numeric characters.

cURL Example

curl 'https://secure-cert.decryptx.com/api/partner/validate' \
    -X POST \
    --header 'Content-Type: application/json' \
    --header 'Accept: application/json' \
    -d '{
            "partnerId"  : "?????????",
            "partnerKey" : "ef1ad938150fb15a1384b883a104ce70",
            "reference"  : "723f57e1-e9c8-48cb-81d9-547ad2b76435"
        }'
//If your credentials are valid you will get a response similar to the following:

{
  "success"   : true,
  "reference" : "723f57e1-e9c8-48cb-81d9-547ad2b76435",
  "messageId" : "1201607010023571033712211"
}

Did this page help you?