API Explorer 936 endpoints

Create Tax Residence

POST /obp/v7.0.0/banks/BANK_ID/customers/CUSTOMER_ID/tax-residence

OBPv3.1.0-createTaxResidence Roles: CanCreateTaxResidence(per bank) CustomerKYC

Create a Tax Residence for a Customer specified by CUSTOMER_ID.

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

URL Parameters:

BANK_ID: gh.29.uk

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

JSON request body fields (2)
domain
tax_number
456
JSON response body fields (3)
domain
tax_number
456
tax_residence_id
Example request body
{
  "domain": "Enter some domain",
  "tax_number": "Enter some number"
}
Example success response
{
  "domain": "Enter some domain",
  "tax_number": "Enter some number",
  "tax_residence_id": "902ba3bb-dedd-45e7-9319-2fd3f2cd98a1"
}
Possible errors (5)
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-20006: User is missing one or more roles:
  • OBP-10001: Incorrect json format.
  • OBP-30046: Customer not found. Please specify a valid value for CUSTOMER_ID.
  • OBP-50000: Unknown Error.
Implemented by OBPv3.1.0 createTaxResidence Originally /obp/v3.1.0/banks/BANK_ID/customers/CUSTOMER_ID/tax-residence