right logo image
right logo image
Log on
⯆

API Explorer

Log off

v5.0.0 (565 APIs)

API Host: https://apisandbox.openbankproject.com
Bank
Accounts
Views
Counterparties
Transactions

Add KYC Check

Add a KYC check for the customer specified by CUSTOMER_ID. KYC Checks store details of checks on a customer made by the KYC team, their comments and a satisfied status

Authentication is Mandatory

URL Parameters:

BANK_ID: gh.29.uk

CUSTOMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh

KYC_CHECK_ID:

JSON response body fields:

bank_id: gh.29.uk

comments:

customer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh

customer_number: 5987953

date: 2020-01-27

how:

id: d8839721-ad8f-45dd-9f78-2080414b93f9

satisfied: false

staff_name:

staff_user_id:

Typical Successful Response: 

								
									
{
  "bank_id":"gh.29.uk",
  "customer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
  "id":"PlaceholderString",
  "customer_number":"5987953",
  "date":"1100-01-01T00:00:00Z",
  "how":"PlaceholderString",
  "staff_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
  "staff_name":"PlaceholderString",
  "satisfied":true,
  "comments":"PlaceholderString"
}
Required Roles:
  • CanAddKycCheck - Please login to request this Role
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-10001: Incorrect json format.
  • OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
  • OBP-30046: Customer not found. Please specify a valid value for CUSTOMER_ID.
  • OBP-00004: Server error: could not add message
  • OBP-50000: Unknown Error.
  • OBP-20006: User is missing one or more roles:
Connector Methods:
Version: OBPv2.0.0, function_name: by addKycCheck, operation_id: OBPv2.0.0-addKycCheck Tags: KYC, Customer,

Add KYC Document

Add a KYC document for the customer specified by CUSTOMER_ID. KYC Documents contain the document type (e.g. passport), place of issue, expiry etc.

Authentication is Mandatory

URL Parameters:

BANK_ID: gh.29.uk

CUSTOMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh

KYC_DOCUMENT_ID:

JSON response body fields:

bank_id: gh.29.uk

customer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh

customer_number: 5987953

expiry_date: 2021-01-27

id: d8839721-ad8f-45dd-9f78-2080414b93f9

issue_date: 2020-01-27

issue_place:

number:

type:

Typical Successful Response: 

								
									
{
  "bank_id":"gh.29.uk",
  "customer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
  "id":"PlaceholderString",
  "customer_number":"5987953",
  "type":"PlaceholderString",
  "number":"PlaceholderString",
  "issue_date":"1100-01-01T00:00:00Z",
  "issue_place":"PlaceholderString",
  "expiry_date":"1100-01-01T00:00:00Z"
}
Required Roles:
  • CanAddKycDocument - Please login to request this Role
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-10001: Incorrect json format.
  • OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
  • OBP-30046: Customer not found. Please specify a valid value for CUSTOMER_ID.
  • Server error: could not add KycDocument
  • OBP-50000: Unknown Error.
  • OBP-20006: User is missing one or more roles:
Connector Methods:
Version: OBPv2.0.0, function_name: by addKycDocument, operation_id: OBPv2.0.0-addKycDocument Tags: KYC, Customer,

Add KYC Media

Add some KYC media for the customer specified by CUSTOMER_ID. KYC Media resources relate to KYC Documents and KYC Checks and contain media urls for scans of passports, utility bills etc

Authentication is Mandatory

URL Parameters:

BANK_ID: gh.29.uk

CUSTOMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh

KYC_MEDIA_ID:

JSON response body fields:

bank_id: gh.29.uk

customer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh

customer_number: 5987953

date: 2020-01-27

id: d8839721-ad8f-45dd-9f78-2080414b93f9

relates_to_kyc_check_id:

relates_to_kyc_document_id:

type:

url: http://www.example.com/id-docs/123/image.png

Typical Successful Response: 

								
									
{
  "bank_id":"gh.29.uk",
  "customer_id":"PlaceholderString",
  "id":"PlaceholderString",
  "customer_number":"5987953",
  "type":"PlaceholderString",
  "url":"PlaceholderString",
  "date":"1100-01-01T00:00:00Z",
  "relates_to_kyc_document_id":"PlaceholderString",
  "relates_to_kyc_check_id":"PlaceholderString"
}
Required Roles:
  • CanAddKycMedia - Please login to request this Role
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-10001: Incorrect json format.
  • OBP-30046: Customer not found. Please specify a valid value for CUSTOMER_ID.
  • OBP-00004: Server error: could not add message
  • OBP-50000: Unknown Error.
  • OBP-20006: User is missing one or more roles:
Connector Methods:
Version: OBPv2.0.0, function_name: by addKycMedia, operation_id: OBPv2.0.0-addKycMedia Tags: KYC, Customer,

Add KYC Status

Add a kyc_status for the customer specified by CUSTOMER_ID. KYC Status is a timeline of the KYC status of the customer

Authentication is Mandatory

URL Parameters:

BANK_ID: gh.29.uk

CUSTOMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh

JSON response body fields:

customer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh

customer_number: 5987953

date: 2020-01-27

ok: false

Typical Successful Response: 

								
									
{
  "customer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
  "customer_number":"5987953",
  "ok":true,
  "date":"1100-01-01T00:00:00Z"
}
Required Roles:
  • CanAddKycStatus - Please login to request this Role
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-10001: Incorrect json format.
  • OBP-30111: Invalid Bank Id. The BANK_ID should only contain 0-9/a-z/A-Z/'-'/'.'/'_', the length should be smaller than 255.
  • OBP-50000: Unknown Error.
  • OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
  • OBP-00004: Server error: could not add message
  • OBP-30046: Customer not found. Please specify a valid value for CUSTOMER_ID.
  • OBP-20006: User is missing one or more roles:
Connector Methods:
Version: OBPv2.0.0, function_name: by addKycStatus, operation_id: OBPv2.0.0-addKycStatus Tags: KYC, Customer,

Get Customer KYC Checks

Get KYC checks for the Customer specified by CUSTOMER_ID.

Authentication is Mandatory

URL Parameters:

CUSTOMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh

JSON response body fields:

bank_id: gh.29.uk

checks:

comments:

customer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh

customer_number: 5987953

date: 2020-01-27

how:

id: d8839721-ad8f-45dd-9f78-2080414b93f9

satisfied: false

staff_name:

staff_user_id:

Typical Successful Response: 

								
									
{
  "checks":[{
    "bank_id":"gh.29.uk",
    "customer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
    "id":"PlaceholderString",
    "customer_number":"5987953",
    "date":"1100-01-01T00:00:00Z",
    "how":"PlaceholderString",
    "staff_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
    "staff_name":"PlaceholderString",
    "satisfied":true,
    "comments":"PlaceholderString"
  }]
}
Required Roles:
  • CanGetAnyKycChecks - Please login to request this Role
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-30046: Customer not found. Please specify a valid value for CUSTOMER_ID.
  • OBP-50000: Unknown Error.
  • OBP-20006: User is missing one or more roles:
Connector Methods:
Version: OBPv2.0.0, function_name: by getKycChecks, operation_id: OBPv2.0.0-getKycChecks Tags: KYC, Customer,

Get Customer KYC Documents

Get KYC (know your customer) documents for a customer specified by CUSTOMER_ID
Get a list of documents that affirm the identity of the customer
Passport, driving licence etc.
Authentication is Optional

Authentication is Mandatory

URL Parameters:

CUSTOMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh

JSON response body fields:

bank_id: gh.29.uk

customer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh

customer_number: 5987953

documents:

expiry_date: 2021-01-27

id: d8839721-ad8f-45dd-9f78-2080414b93f9

issue_date: 2020-01-27

issue_place:

number:

type:

Typical Successful Response: 

								
									
{
  "documents":[{
    "bank_id":"gh.29.uk",
    "customer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
    "id":"PlaceholderString",
    "customer_number":"5987953",
    "type":"PlaceholderString",
    "number":"PlaceholderString",
    "issue_date":"1100-01-01T00:00:00Z",
    "issue_place":"PlaceholderString",
    "expiry_date":"1100-01-01T00:00:00Z"
  }]
}
Required Roles:
  • CanGetAnyKycDocuments - Please login to request this Role
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-30046: Customer not found. Please specify a valid value for CUSTOMER_ID.
  • OBP-50000: Unknown Error.
  • OBP-20006: User is missing one or more roles:
Connector Methods:
Version: OBPv2.0.0, function_name: by getKycDocuments, operation_id: OBPv2.0.0-getKycDocuments Tags: KYC, Customer,

Get Customer KYC statuses

Get the KYC statuses for a customer specified by CUSTOMER_ID over time.

Authentication is Mandatory

URL Parameters:

CUSTOMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh

JSON response body fields:

customer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh

customer_number: 5987953

date: 2020-01-27

ok: false

statuses:

Typical Successful Response: 

								
									
{
  "statuses":[{
    "customer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
    "customer_number":"5987953",
    "ok":true,
    "date":"1100-01-01T00:00:00Z"
  }]
}
Required Roles:
  • CanGetAnyKycStatuses - Please login to request this Role
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-30046: Customer not found. Please specify a valid value for CUSTOMER_ID.
  • OBP-50000: Unknown Error.
  • OBP-20006: User is missing one or more roles:
Connector Methods:
Version: OBPv2.0.0, function_name: by getKycStatuses, operation_id: OBPv2.0.0-getKycStatuses Tags: KYC, Customer,

Get KYC Media for a customer

Get KYC media (scans, pictures, videos) that affirms the identity of the customer.

Authentication is Mandatory

URL Parameters:

CUSTOMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh

JSON response body fields:

bank_id: gh.29.uk

customer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh

customer_number: 5987953

date: 2020-01-27

id: d8839721-ad8f-45dd-9f78-2080414b93f9

medias:

relates_to_kyc_check_id:

relates_to_kyc_document_id:

type:

url: http://www.example.com/id-docs/123/image.png

Typical Successful Response: 

								
									
{
  "medias":[{
    "bank_id":"gh.29.uk",
    "customer_id":"PlaceholderString",
    "id":"PlaceholderString",
    "customer_number":"5987953",
    "type":"PlaceholderString",
    "url":"PlaceholderString",
    "date":"1100-01-01T00:00:00Z",
    "relates_to_kyc_document_id":"PlaceholderString",
    "relates_to_kyc_check_id":"PlaceholderString"
  }]
}
Required Roles:
  • CanGetAnyKycMedia - Please login to request this Role
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-30046: Customer not found. Please specify a valid value for CUSTOMER_ID.
  • OBP-50000: Unknown Error.
  • OBP-20006: User is missing one or more roles:
Connector Methods:
Version: OBPv2.0.0, function_name: by getKycMedia, operation_id: OBPv2.0.0-getKycMedia Tags: KYC, Customer,