API Explorer 1 endpoints

Get KYC Media for a customer

GET /obp/v7.0.0/customers/CUSTOMER_ID/kyc_media

OBPv2.0.0-getKycMedia Roles: CanGetAnyKycMedia KYCCustomer

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

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

URL Parameters:

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

JSON response body fields (10)
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
Example success 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"
    }
  ]
}
Possible errors (4)
  • 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:
Implemented by OBPv2.0.0 getKycMedia Originally /obp/v2.0.0/customers/CUSTOMER_ID/kyc_media