Open Bank Project |
OBP v4.0.0 filtered by tag: KYC (18 APIs)
API Host: https://api.openbankproject.com
BankAccountsViewsCounterpartiesTransactionsCreate Tax ResidenceCreate a Tax Residence for a Customer specified by CUSTOMER_ID. Authentication is Mandatory Typical Successful Response:
Headers:
Required Roles:
Possible Errors:
Connector Methods:
Implemented in OBPv3.1.0 by createTaxResidence
Delete Customer AddressDelete an Address of the Customer specified by CUSTOMER_ADDRESS_ID. Authentication is Mandatory Typical Successful Response:
Headers:
Required Roles:
Possible Errors:
Implemented in OBPv3.1.0 by deleteCustomerAddress
Delete Tax ResidenceDelete a Tax Residence of the Customer specified by TAX_RESIDENCE_ID. Authentication is Mandatory Typical Successful Response:
Headers:
Possible Errors:
Connector Methods:
Implemented in OBPv3.1.0 by deleteTaxResidence
Get Customer AddressesGet the Addresses of the Customer specified by CUSTOMER_ID. Authentication is Mandatory Typical Successful Response:
Headers:
Required Roles:
Possible Errors:
Connector Methods:
Implemented in OBPv3.1.0 by getCustomerAddresses
Get Customer by CUSTOMER_NUMBERGets the Customer specified by CUSTOMER_NUMBER. Authentication is Mandatory Typical Successful Response:
Headers:
Required Roles:
Possible Errors:
Implemented in OBPv3.1.0 by getCustomerByCustomerNumber
Get Customers by MOBILE_PHONE_NUMBERGets the Customers specified by MOBILE_PHONE_NUMBER. There are two wildcards often used in conjunction with the LIKE operator: Authentication is Mandatory Typical Successful Response:
Headers:
Possible Errors:
Connector Methods:
Implemented in OBPv4.0.0 by getCustomersByCustomerPhoneNumber
Get Tax Residences of CustomerGet the Tax Residences of the Customer specified by CUSTOMER_ID. Authentication is Mandatory Typical Successful Response:
Headers:
Possible Errors:
Connector Methods:
Implemented in OBPv3.1.0 by getTaxResidence
Create Meeting (video conference/call)Create Meeting: Initiate a video conference/call with the bank. The Meetings resource contains meta data about video/other conference sessions provider_id determines the provider of the meeting / video chat service. MUST be url friendly (no spaces). purpose_id explains the purpose of the chat. onboarding | mortgage | complaint etc. MUST be url friendly (no spaces). Login is required. This call is experimental. Currently staff_user_id is not set. Further calls will be needed to correctly set this. Authentication is Mandatory Typical Successful Response:
Headers:
Possible Errors:
Connector Methods:
Implemented in OBPv3.1.0 by createMeeting
Get MeetingGet Meeting specified by BANK_ID / MEETING_ID The actual conference/chats are handled by external services. Login is required. This call is experimental and will require further authorisation in the future. Authentication is Mandatory Typical Successful Response:
Headers:
Possible Errors:
Connector Methods:
Implemented in OBPv3.1.0 by getMeeting
Get MeetingsMeetings contain meta data about, and are used to facilitate, video conferences / chats etc. The actual conference/chats are handled by external services. Login is required. This call is experimental and will require further authorisation in the future. Authentication is Mandatory Typical Successful Response:
Headers:
Possible Errors:
Connector Methods:
Implemented in OBPv3.1.0 by getMeetings
Add KYC CheckAdd 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 Typical Successful Response:
Headers:
Required Roles:
Possible Errors:
Implemented in OBPv2.0.0 by addKycCheck
Add KYC DocumentAdd 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 Typical Successful Response:
Headers:
Required Roles:
Possible Errors:
Implemented in OBPv2.0.0 by addKycDocument
Add KYC MediaAdd 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 Typical Successful Response:
Headers:
Required Roles:
Possible Errors:
Implemented in OBPv2.0.0 by addKycMedia
Add KYC StatusAdd 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 Typical Successful Response:
Headers:
Required Roles:
Possible Errors:
Implemented in OBPv2.0.0 by addKycStatus
Get Customer KYC ChecksGet KYC checks for the Customer specified by CUSTOMER_ID. Authentication is Mandatory Typical Successful Response:
Headers:
Required Roles:
Possible Errors:
Connector Methods:
Implemented in OBPv2.0.0 by getKycChecks
Get Customer KYC DocumentsGet KYC (know your customer) documents for a customer specified by CUSTOMER_ID Authentication is Mandatory Typical Successful Response:
Headers:
Required Roles:
Possible Errors:
Connector Methods:
Implemented in OBPv2.0.0 by getKycDocuments
Get Customer KYC statusesGet the KYC statuses for a customer specified by CUSTOMER_ID over time. Authentication is Mandatory Typical Successful Response:
Headers:
Required Roles:
Possible Errors:
Connector Methods:
Implemented in OBPv2.0.0 by getKycStatuses
Get KYC Media for a customerGet KYC media (scans, pictures, videos) that affirms the identity of the customer. Authentication is Mandatory Typical Successful Response:
Headers:
Required Roles:
Possible Errors:
Connector Methods:
Implemented in OBPv2.0.0 by getKycMedia
|