REST Bank Open Api by BoC

API change history

A developer preview of the brand new BoC Ibank Api. Play in the api playground, connect it to your new app!

getCustomers

List all customers

Try it

Request URL

Request parameters

string

Swift Bank Code

(optional)
string

subscription key in url

Request headers

string

Auth-Provider-Name

string

Auth-ID

(optional)
string

subscription key in header

string
Subscription key which provides access to this API. Found in your Profile.

Request body

Response 200

Successful json response

{
  "customers": [
    {
      "bank_id": [
        "string"
      ],
      "customer_number": "string",
      "date_values": [
        {
          "key": "string",
          "string": "string"
        }
      ],
      "email": "string",
      "face_image": {
        "name": "string"
      },
      "legal_name": "string",
      "mobile_phone_number": "string",
      "numeric_values": [
        {
          "key": "string",
          "string": "string"
        }
      ],
      "string_values": [
        {
          "key": "string",
          "string": "string"
        }
      ]
    }
  ]
}
{
  "description": "Model for CustomersResponse",
  "required": [
    "customers"
  ],
  "properties": {
    "customers": {
      "type": "array",
      "items": {
        "description": "Model for CustomerDef",
        "properties": {
          "bank_id": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "customer_number": {
            "type": "string"
          },
          "date_values": {
            "type": "array",
            "items": {
              "description": "Model for StringValues",
              "required": [
                "key"
              ],
              "properties": {
                "key": {
                  "type": "string"
                },
                "string": {
                  "type": "string"
                }
              }
            }
          },
          "email": {
            "type": "string"
          },
          "face_image": {
            "description": "Model for FaceImage",
            "required": [
              "name"
            ],
            "properties": {
              "name": {
                "type": "string"
              }
            }
          },
          "legal_name": {
            "type": "string"
          },
          "mobile_phone_number": {
            "type": "string"
          },
          "numeric_values": {
            "type": "array",
            "items": {
              "description": "Model for StringValues",
              "required": [
                "key"
              ],
              "properties": {
                "key": {
                  "type": "string"
                },
                "string": {
                  "type": "string"
                }
              }
            }
          },
          "string_values": {
            "type": "array",
            "items": {
              "description": "Model for StringValues",
              "required": [
                "key"
              ],
              "properties": {
                "key": {
                  "type": "string"
                },
                "string": {
                  "type": "string"
                }
              }
            }
          }
        }
      }
    }
  }
}

Response 403

Forbidden Response Message

Response 404

Not Found Response Message

Response 500

Server Response Message

Code samples

@ECHO OFF

curl -v -X GET "http://api.bocapi.net/v1/api/banks/{BANK_ID}/customers?subscription-key={string}"
-H "Auth-Provider-Name: "
-H "Auth-ID: "
-H "Ocp-Apim-Subscription-Key: "
-H "Ocp-Apim-Subscription-Key: {subscription key}"

--data-ascii "{body}" 
using System;
using System.Net.Http.Headers;
using System.Text;
using System.Net.Http;
using System.Web;

namespace CSHttpClientSample
{
    static class Program
    {
        static void Main()
        {
            MakeRequest();
            Console.WriteLine("Hit ENTER to exit...");
            Console.ReadLine();
        }
        
        static async void MakeRequest()
        {
            var client = new HttpClient();
            var queryString = HttpUtility.ParseQueryString(string.Empty);

            // Request headers
            client.DefaultRequestHeaders.Add("Auth-Provider-Name", "");
            client.DefaultRequestHeaders.Add("Auth-ID", "");
            client.DefaultRequestHeaders.Add("Ocp-Apim-Subscription-Key", "");
            client.DefaultRequestHeaders.Add("Ocp-Apim-Subscription-Key", "{subscription key}");

            // Request parameters
            queryString["subscription-key"] = "{string}";
            var uri = "http://api.bocapi.net/v1/api/banks/{BANK_ID}/customers?" + queryString;

            var response = await client.GetAsync(uri);
        }
    }
}	
// // This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
import java.net.URI;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.client.utils.URIBuilder;
import org.apache.http.impl.client.HttpClients;
import org.apache.http.util.EntityUtils;

public class JavaSample 
{
    public static void main(String[] args) 
    {
        HttpClient httpclient = HttpClients.createDefault();

        try
        {
            URIBuilder builder = new URIBuilder("http://api.bocapi.net/v1/api/banks/{BANK_ID}/customers");

            builder.setParameter("subscription-key", "{string}");

            URI uri = builder.build();
            HttpGet request = new HttpGet(uri);
            request.setHeader("Auth-Provider-Name", "");
            request.setHeader("Auth-ID", "");
            request.setHeader("Ocp-Apim-Subscription-Key", "");
            request.setHeader("Ocp-Apim-Subscription-Key", "{subscription key}");


            // Request body
            StringEntity reqEntity = new StringEntity("{body}");
            request.setEntity(reqEntity);

            HttpResponse response = httpclient.execute(request);
            HttpEntity entity = response.getEntity();

            if (entity != null) 
            {
                System.out.println(EntityUtils.toString(entity));
            }
        }
        catch (Exception e)
        {
            System.out.println(e.getMessage());
        }
    }
}

<!DOCTYPE html>
<html>
<head>
    <title>JSSample</title>
    <script src="http://ajax.googleapis.com/ajax/libs/jquery/1.9.0/jquery.min.js"></script>
</head>
<body>

<script type="text/javascript">
    $(function() {
        var params = {
            // Request parameters
            "subscription-key": "{string}",
        };
      
        $.ajax({
            url: "http://api.bocapi.net/v1/api/banks/{BANK_ID}/customers?" + $.param(params),
            beforeSend: function(xhrObj){
                // Request headers
                xhrObj.setRequestHeader("Auth-Provider-Name","");
                xhrObj.setRequestHeader("Auth-ID","");
                xhrObj.setRequestHeader("Ocp-Apim-Subscription-Key","");
                xhrObj.setRequestHeader("Ocp-Apim-Subscription-Key","{subscription key}");
            },
            type: "GET",
            // Request body
            data: "{body}",
        })
        .done(function(data) {
            alert("success");
        })
        .fail(function() {
            alert("error");
        });
    });
</script>
</body>
</html>
#import <Foundation/Foundation.h>

int main(int argc, const char * argv[])
{
    NSAutoreleasePool * pool = [[NSAutoreleasePool alloc] init];
    
    NSString* path = @"http://api.bocapi.net/v1/api/banks/{BANK_ID}/customers";
    NSArray* array = @[
                         // Request parameters
                         @"entities=true",
                         @"subscription-key={string}",
                      ];
    
    NSString* string = [array componentsJoinedByString:@"&"];
    path = [path stringByAppendingFormat:@"?%@", string];

    NSLog(@"%@", path);

    NSMutableURLRequest* _request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:path]];
    [_request setHTTPMethod:@"GET"];
    // Request headers
    [_request setValue:@"" forHTTPHeaderField:@"Auth-Provider-Name"];
    [_request setValue:@"" forHTTPHeaderField:@"Auth-ID"];
    [_request setValue:@"" forHTTPHeaderField:@"Ocp-Apim-Subscription-Key"];
    [_request setValue:@"{subscription key}" forHTTPHeaderField:@"Ocp-Apim-Subscription-Key"];
    // Request body
    [_request setHTTPBody:[@"{body}" dataUsingEncoding:NSUTF8StringEncoding]];
    
    NSURLResponse *response = nil;
    NSError *error = nil;
    NSData* _connectionData = [NSURLConnection sendSynchronousRequest:_request returningResponse:&response error:&error];

    if (nil != error)
    {
        NSLog(@"Error: %@", error);
    }
    else
    {
        NSError* error = nil;
        NSMutableDictionary* json = nil;
        NSString* dataString = [[NSString alloc] initWithData:_connectionData encoding:NSUTF8StringEncoding];
        NSLog(@"%@", dataString);
        
        if (nil != _connectionData)
        {
            json = [NSJSONSerialization JSONObjectWithData:_connectionData options:NSJSONReadingMutableContainers error:&error];
        }
        
        if (error || !json)
        {
            NSLog(@"Could not parse loaded json with error:%@", error);
        }
        
        NSLog(@"%@", json);
        _connectionData = nil;
    }
    
    [pool drain];

    return 0;
}
<?php
// This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
require_once 'HTTP/Request2.php';

$request = new Http_Request2('http://api.bocapi.net/v1/api/banks/{BANK_ID}/customers');
$url = $request->getUrl();

$headers = array(
    // Request headers
    'Auth-Provider-Name' => '',
    'Auth-ID' => '',
    'Ocp-Apim-Subscription-Key' => '',
    'Ocp-Apim-Subscription-Key' => '{subscription key}',
);

$request->setHeader($headers);

$parameters = array(
    // Request parameters
    'subscription-key' => '{string}',
);

$url->setQueryVariables($parameters);

$request->setMethod(HTTP_Request2::METHOD_GET);

// Request body
$request->setBody("{body}");

try
{
    $response = $request->send();
    echo $response->getBody();
}
catch (HttpException $ex)
{
    echo $ex;
}

?>
########### Python 2.7 #############
import httplib, urllib, base64

headers = {
    # Request headers
    'Auth-Provider-Name': '',
    'Auth-ID': '',
    'Ocp-Apim-Subscription-Key': '',
    'Ocp-Apim-Subscription-Key': '{subscription key}',
}

params = urllib.urlencode({
    # Request parameters
    'subscription-key': '{string}',
})

try:
    conn = httplib.HTTPConnection('api.bocapi.net')
    conn.request("GET", "/v1/api/banks/{BANK_ID}/customers?%s" % params, "{body}", headers)
    response = conn.getresponse()
    data = response.read()
    print(data)
    conn.close()
except Exception as e:
    print("[Errno {0}] {1}".format(e.errno, e.strerror))

####################################

########### Python 3.2 #############
import http.client, urllib.request, urllib.parse, urllib.error, base64

headers = {
    # Request headers
    'Auth-Provider-Name': '',
    'Auth-ID': '',
    'Ocp-Apim-Subscription-Key': '',
    'Ocp-Apim-Subscription-Key': '{subscription key}',
}

params = urllib.parse.urlencode({
    # Request parameters
    'subscription-key': '{string}',
})

try:
    conn = http.client.HTTPConnection('api.bocapi.net')
    conn.request("GET", "/v1/api/banks/{BANK_ID}/customers?%s" % params, "{body}", headers)
    response = conn.getresponse()
    data = response.read()
    print(data)
    conn.close()
except Exception as e:
    print("[Errno {0}] {1}".format(e.errno, e.strerror))

####################################
require 'net/http'

uri = URI('http://api.bocapi.net/v1/api/banks/{BANK_ID}/customers')

query = URI.encode_www_form({
    # Request parameters
    'subscription-key' => '{string}'
})
if query.length > 0
  if uri.query && uri.query.length > 0
    uri.query += '&' + query
  else
    uri.query = query
  end
end

request = Net::HTTP::Get.new(uri.request_uri)
# Request headers
request['Auth-Provider-Name'] = ''
# Request headers
request['Auth-ID'] = ''
# Request headers
request['Ocp-Apim-Subscription-Key'] = ''
# Request headers
request['Ocp-Apim-Subscription-Key'] = '{subscription key}'
# Request body
request.body = "{body}"

response = Net::HTTP.start(uri.host, uri.port, :use_ssl => uri.scheme == 'https') do |http|
    http.request(request)
end

puts response.body