Open Bank Project
|
OBP v4.0.0 filtered by tag: Customer, KYC, Onboarding (56 APIs)
API Host: https://api.openbankproject.com
BankAccountsViewsCounterpartiesTransactionsCreate AccountCreate Account at bank specified by BANK_ID with Id specified by ACCOUNT_ID. The User can create an Account for themself - or - the User that has the USER_ID specified in the POST body. If the PUT body USER_ID is specified, the logged in user must have the Role canCreateAccount. Once created, the Account will be owned by the User specified by USER_ID. If the PUT body USER_ID is not specified, the account will be owned by the logged in User. The 'product_code' field SHOULD be a product_code from Product. Note: The Amount MUST be zero. Authentication is Mandatory Typical Successful Response:
Headers:
Required Roles:
Possible Errors:
Implemented in OBPv3.1.0 by createAccount
Create Account (POST)Create Account at bank specified by BANK_ID. The User can create an Account for himself - or - the User that has the USER_ID specified in the POST body. If the POST body USER_ID is specified, the logged in user must have the Role CanCreateAccount. Once created, the Account will be owned by the User specified by USER_ID. If the POST body USER_ID is not specified, the account will be owned by the logged in User. The 'product_code' field SHOULD be a product_code from Product. Note: The Amount MUST be zero. Authentication is Mandatory Typical Successful Response:
Headers:
Required Roles:
Possible Errors:
Implemented in OBPv4.0.0 by addAccount
Add Social Media HandleAdd a social media handle 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 addSocialMediaHandle
Create AddressCreate an Address for a Customer specified by CUSTOMER_ID. Authentication is Mandatory Typical Successful Response:
Headers:
Required Roles:
Possible Errors:
Implemented in OBPv3.1.0 by createCustomerAddress
Create Credit Limit Order RequestNOTE: This endpoint currently only returns example data. Create credit limit order request Authentication is Optional Typical Successful Response:
Headers:
Possible Errors:
Connector Methods:
Implemented in OBPv3.1.0 by createCreditLimitRequest
Create CustomerThe Customer resource stores the customer number, legal name, email, phone number, their date of birth, relationship status, education attained, a url for a profile image, KYC status etc. Authentication is Mandatory Typical Successful Response:
Headers:
Required Roles:
Possible Errors:
Connector Methods:
Implemented in OBPv3.1.0 by createCustomer
Create Customer AttributeCreate Customer Attribute The type field must be one of "STRING", "INTEGER", "DOUBLE" or DATE_WITH_DAY" Authentication is Mandatory Typical Successful Response:
Headers:
Required Roles:
Possible Errors:
Implemented in OBPv4.0.0 by createCustomerAttribute
Create 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
Create User Customer LinkLink a User to a Customer Authentication is Mandatory CanCreateUserCustomerLink OR CanCreateUserCustomerLinkAtAnyBank entitlements are required. Typical Successful Response:
Headers:
Required Roles:
Possible Errors:
Implemented in OBPv2.0.0 by createUserCustomerLinks
Create or Update Customer Attribute DefinitionCreate or Update Customer Attribute Definition The category field must be one of: Customer The type field must be one of; DOUBLE, STRING, INTEGER and DATE_WITH_DAY Authentication is Mandatory Typical Successful Response:
Headers:
Required Roles:
Possible Errors:
Connector Methods:
Implemented in OBPv4.0.0 by createOrUpdateCustomerAttributeAttributeDefinition
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 Customer AttributeDelete Customer Attribute CustomerAttributes are used to enhance the OBP Customer object with Bank specific entities. Delete a Customer Attribute by its id. Authentication is Mandatory Typical Successful Response:
Headers:
Required Roles:
Possible Errors:
Connector Methods:
Implemented in OBPv4.0.0 by deleteCustomerAttribute
Delete Customer Attribute DefinitionDelete Customer Attribute Definition by ATTRIBUTE_DEFINITION_ID Authentication is Mandatory Typical Successful Response:
Headers:
Required Roles:
Possible Errors:
Connector Methods:
Implemented in OBPv4.0.0 by deleteCustomerAttributeDefinition
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
Delete User Customer LinkDelete User Customer Link by USER_CUSTOMER_LINK_ID Authentication is Mandatory Typical Successful Response:
Headers:
Required Roles:
Possible Errors:
Connector Methods:
Implemented in OBPv4.0.0 by deleteUserCustomerLink
Get CRM EventsAuthentication is Mandatory Typical Successful Response:
Headers:
Possible Errors:
Connector Methods:
Implemented in OBPv1.4.0 by getCrmEvents
Get Credit Limit Order Request By Request IdNOTE: This endpoint currently only returns example data.
Authentication is Optional Typical Successful Response:
Headers:
Possible Errors:
Connector Methods:
Implemented in OBPv3.1.0 by getCreditLimitRequestByRequestId
Get Credit Limit Order RequestsNOTE: This endpoint currently only returns example data. Get Credit Limit Order Requests Authentication is Optional Typical Successful Response:
Headers:
Possible Errors:
Connector Methods:
Implemented in OBPv3.1.0 by getCreditLimitRequests
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 Attribute By IdGet Customer Attribute By Id Authentication is Mandatory Typical Successful Response:
Headers:
Required Roles:
Possible Errors:
Implemented in OBPv4.0.0 by getCustomerAttributeById
Get Customer Attribute DefinitionGet Customer Attribute Definition Authentication is Mandatory Typical Successful Response:
Headers:
Required Roles:
Possible Errors:
Connector Methods:
Implemented in OBPv4.0.0 by getCustomerAttributeDefinition
Get Customer AttributesGet Customer Attributes Authentication is Mandatory Typical Successful Response:
Headers:
Required Roles:
Possible Errors:
Implemented in OBPv4.0.0 by getCustomerAttributes
Get Customer Social Media HandlesGet social media handles 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 getSocialMediaHandles
Get Customer by CUSTOMER_IDGets the Customer specified by CUSTOMER_ID. Authentication is Mandatory Typical Successful Response:
Headers:
Required Roles:
Possible Errors:
Implemented in OBPv3.1.0 by getCustomerByCustomerId
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 ATTRIBUTESGets the Customers specified by attributes URL params example: /banks/some-bank-id/customers?name=John&age=8 Authentication is Mandatory Typical Successful Response:
Headers:
Required Roles:
Possible Errors:
Implemented in OBPv4.0.0 by getCustomersByAttributes
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 Customers for Current UserGets all Customers that are linked to a User. Authentication is Mandatory Typical Successful Response:
Headers:
Possible Errors:
Implemented in OBPv3.0.0 by getCustomersForUser
Get Firehose CustomersGet Customers that has a firehose View. Allows bulk access to customers. Possible custom URL parameters for pagination:
Date format parameter: yyyy-MM-dd'T'HH:mm:ss.SSS'Z'(2017-09-19T02:31:05.000Z) ==> time zone is UTC. Authentication is Mandatory Typical Successful Response:
Headers:
Required Roles:
Possible Errors:
Implemented in OBPv3.1.0 by getFirehoseCustomers
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
Get User Customer Links by CustomerGet User Customer Links by CUSTOMER_ID Authentication is Mandatory Typical Successful Response:
Headers:
Required Roles:
Possible Errors:
Connector Methods:
Implemented in OBPv4.0.0 by getUserCustomerLinksByCustomerId
Get User Customer Links by UserGet User Customer Links by USER_ID Authentication is Mandatory Typical Successful Response:
Headers:
Required Roles:
Possible Errors:
Connector Methods:
Implemented in OBPv4.0.0 by getUserCustomerLinksByUserId
Update Customer AttributeUpdate Customer Attribute Authentication is Mandatory Typical Successful Response:
Headers:
Required Roles:
Possible Errors:
Implemented in OBPv4.0.0 by updateCustomerAttribute
Update the Address of a CustomerUpdate an Address of the Customer specified by CUSTOMER_ADDRESS_ID. Authentication is Mandatory Typical Successful Response:
Headers:
Possible Errors:
Implemented in OBPv3.1.0 by updateCustomerAddress
Update the Branch of a CustomerUpdate the Branch of the Customer specified by CUSTOMER_ID. Authentication is Mandatory Typical Successful Response:
Headers:
Required Roles:
Possible Errors:
Implemented in OBPv3.1.0 by updateCustomerBranch
Update the credit limit of a CustomerUpdate the credit limit of the Customer specified by CUSTOMER_ID. Authentication is Mandatory Typical Successful Response:
Headers:
Required Roles:
Possible Errors:
Implemented in OBPv3.1.0 by updateCustomerCreditLimit
Update the credit rating and source of a CustomerUpdate the credit rating and source of the Customer specified by CUSTOMER_ID. Authentication is Mandatory Typical Successful Response:
Headers:
Required Roles:
Possible Errors:
Implemented in OBPv3.1.0 by updateCustomerCreditRatingAndSource
Update the email of a CustomerUpdate an email of the Customer specified by CUSTOMER_ID. Authentication is Mandatory Typical Successful Response:
Headers:
Required Roles:
Possible Errors:
Implemented in OBPv3.1.0 by updateCustomerEmail
Update the identity data of a CustomerUpdate the identity data of the Customer specified by CUSTOMER_ID. Authentication is Mandatory Typical Successful Response:
Headers:
Required Roles:
Possible Errors:
Implemented in OBPv3.1.0 by updateCustomerIdentity
Update the mobile number of a CustomerUpdate the mobile number of the Customer specified by CUSTOMER_ID. Authentication is Mandatory Typical Successful Response:
Headers:
Required Roles:
Possible Errors:
Implemented in OBPv3.1.0 by updateCustomerMobileNumber
Update the number of a CustomerUpdate the number of the Customer specified by CUSTOMER_ID. Authentication is Mandatory Typical Successful Response:
Headers:
Required Roles:
Possible Errors:
Implemented in OBPv3.1.0 by updateCustomerNumber
Update the other data of a CustomerUpdate the other data of the Customer specified by CUSTOMER_ID. Authentication is Mandatory Typical Successful Response:
Headers:
Required Roles:
Possible Errors:
Implemented in OBPv3.1.0 by updateCustomerData
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
Create Customer MessageCreate a message for the customer specified by CUSTOMER_ID Authentication is Mandatory Typical Successful Response:
Headers:
Possible Errors:
Connector Methods:
Implemented in OBPv1.4.0 by createCustomerMessage
Get Customer Messages (current)Get messages for the logged in customer Authentication via OAuth is required. Authentication is Mandatory Typical Successful Response:
Headers:
Possible Errors:
Connector Methods:
Implemented in OBPv1.4.0 by getCustomerMessages
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
Create UserCreates OBP user. Mimics current webform to Register. Requires username(email) and password. Returns 409 error if username not unique. May require validation of email address. Authentication is Mandatory Typical Successful Response:
Headers:
Possible Errors:
Connector Methods:
Implemented in OBPv2.0.0 by createUser
|