Authentication

Secret Token

You authenticate to the SVB Developer API by providing your secret API key in each request. The APIs only operate over HTTPS so all request data (including your API key) stays encrypted and secret.

Environment information will be specified on the api key:

       Sandbox access:     api key will start with test_ 
       Production access: api key will start with live_ 

To provide your API key with a request, pass it in the HTTP Authorization header as a bearer token:

Authorization: Bearer YOUR_API_KEY

Example request:

curl -H "Authorization: Bearer YOUR_API_KEY" \
    https://uat.api.svb.com/v1

Note: Store your API key in a secure location. Anyone who obtains your key can access the API with all of your privileges.

The SVB Developer API requires an additional layer of security in the form of request signing via HMAC. Request signing uses a second secret key that is never transmitted over the wire to the API. This mitigates two additional attack vectors that a single API token does not:

• an attacker is unable to replay a previous request to the API; and
• an attacker is unable to modify the API request during transmission.

HMAC signing can be implemented in any language.

Algorithm

To sign a request, you’ll need a few things:

• a crypto library that supports HMAC-SHA-256;
• your secret HMAC signing key;
• your HTTP request contents; and
• the current time (from a reasonably accurate clock).

The signature is calculated using the following fields:

Using this Algorithm

1. Let + be a function that concatenates strings, and let "\n"indicate a newline character;
2. Let HMAC be a function that calculates an HMAC from a string and a secret key, and let HEX be a function that returns the string hexadecimal representation of its input; then
3. The signature is:

HEX( HMAC( your_secret_key,
           timestamp + "\n" +
           method + "\n" +
           path + "\n" +
           query + "\n" +
           body ))

Notes:

• body is only used for JSON bodies with the application/jsontype. if the body is any other type or is missing, then an empty string should be used instead.
• The only endpoint that uses a non-JSON body is /v1/files. That endpoint uses the multipart/form-data type and an empty string should be used for body when computing the signature.
• path always begins with a slash.
• query omits the leading question mark, and is an empty string if there is no query string.
  
  

Headers

After calculating the signature, add the following two HTTP headers to your request:

• X-Timestamp: timestamp, from step (2) above
• X-Signature: the request signature

For a request to be considered valid, it must have a timestamp within 30 seconds of the server’s time as well as a valid signature.

Code Samples and Examples

SVB API documentation includes Python and Postman examples to simplify client integrations. Python code samples and Postman collections provide examples of API requests that use HMAC signing. 

We recommend IP whitelisting as an additional means of controlling access to the SVB Developer API whenever possible. While some architectures may preclude IP whitelisting as a viable means of protection, this additional level of security can help mitigate certain attacks. The Developer API can whitelist individual addresses or CIDR ranges of IP addresses as needed.

Contact the SVB API team to configure or modify existing IP restrictions.