|
Version | Date | Author | Comments |
---|---|---|---|
3.0 | OB R/W API Team | This is the baseline version. No change from RC3. | |
3.1-draft1 | OB R/W API Team | This is the initial draft version for 3.1. Errata
| |
3.1-draft2 | OB R/W API Team | Draft2 Changes:
| |
3.1 | OB R/W API Team | Version 3.1 final release. No changes from Version 3.1 RC1. |
Endpoints for the resource and available methods.
Resource | HTTP Operation | Endpoint | Mandatory? | Scope | Grant Type | Idempotency Key | Parameters | Request Object | Response Object | |
---|---|---|---|---|---|---|---|---|---|---|
1 | party | GET | GET /accounts/{AccountId}/party | Conditional | accounts | Authorization Code | No | OBReadParty1 | ||
2 | party | GET | GET /party | Conditional | accounts | Authorization Code | No | OBReadParty1 |
If the ASPSP has chosen to implement the /accounts/{AccountId}/party endpoint, the ASPSP must return details on the account owner:
GET /party
If the ASPSP has chosen to implement the /party endpoint, the ASPSP must return details on the user that has authorised the account-request with the ASPSP:
The OBReadParty1 object will be used for the call to:
A resource that contains a set of elements that describes the party linked to a specific account (AccountId).
The response to GET /accounts/{AccountId}/party and GET /party (if available) must contain at most one party.
The ReadParty permission is required to access GET /accounts/{AccountId}/party. The resource response payload does not differ depending on the permissions granted.
The ReadPartyPSU permission is required to access GET /party. The resource response payload does not differ depending on the permissions granted.
Name | Occurrence | XPath | EnhancedDefinition | Class | Codes | Pattern |
---|---|---|---|---|---|---|
OBReadParty1 | OBReadParty1 | OBReadParty1 | ||||
Data | 1..1 | OBReadParty1/Data | OBReadDataParty1 | |||
Party | 0..1 | OBReadParty1/Data/Party | OBParty1 | |||
PartyId | 1..1 | OBReadParty1/Data/Party/PartyId | A unique and immutable identifier used to identify the customer resource. This identifier has no meaning to the account owner. | Max40Text | ||
PartyNumber | 0..1 | OBReadParty1/Data/Party/PartyNumber | Number assigned by an agent to identify its customer. | Max35Text | ||
PartyType | 0..1 | OBReadParty1/Data/Party/PartyType | Party type, in a coded form. | OBExternalPartyType1Code | Delegate Joint Sole | |
Name | 0..1 | OBReadParty1/Data/Party/Name | Name by which a party is known and which is usually used to identify that party. | Max70Text | ||
EmailAddress | 0..1 | OBReadParty1/Data/Party/EmailAddress | Address for electronic mail (e-mail). | Max256Text | ||
Phone | 0..1 | OBReadParty1/Data/Party/Phone | Collection of information that identifies a phone number, as defined by telecom services. | PhoneNumber | \+[0-9]{1,3}-[0-9()+\-]{1,30} | |
Mobile | 0..1 | OBReadParty1/Data/Party/Mobile | Collection of information that identifies a mobile phone number, as defined by telecom services. | PhoneNumber | \+[0-9]{1,3}-[0-9()+\-]{1,30} | |
Address | 0..n | OBReadParty1/Data/Party/Address | Postal address of a party. | OBPostalAddress8 | ||
AddressType | 0..1 | OBReadParty1/Data/Party/Address/AddressType | Identifies the nature of the postal address. | OBAddressTypeCode | Business Correspondence DeliveryTo MailTo POBox Postal Residential Statement | |
AddressLine | 0..5 | OBReadParty1/Data/Party/Address/AddressLine | Information that locates and identifies a specific address, as defined by postal services, that is presented in free format text. | Max70Text | ||
StreetName | 0..1 | OBReadParty1/Data/Party/Address/StreetName | Name of a street or thoroughfare. | Max70Text | ||
BuildingNumber | 0..1 | OBReadParty1/Data/Party/Address/BuildingNumber | Number that identifies the position of a building on a street. | Max16Text | ||
PostCode | 0..1 | OBReadParty1/Data/Party/Address/PostCode | Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail. | Max16Text | ||
TownName | 0..1 | OBReadParty1/Data/Party/Address/TownName | Name of a built-up area, with defined boundaries, and a local government. | Max35Text | ||
CountrySubDivision | 0..1 | OBReadParty1/Data/Party/Address/CountrySubDivision | Identifies a subdivision of a country eg, state, region, county. | Max35Text | ||
Country | 1..1 | OBReadParty1/Data/Party/Address/Country | Nation with its own government, occupying a particular territory. | CountryCode | ^[A-Z]{2,2}$ |
Request
GET /accounts/22289/party HTTP/1.1 Authorization: Bearer Az90SAOJklae x-fapi-financial-id: OB/2017/001 x-fapi-customer-last-logged-time: Sun, 10 Sep 2017 19:43:31 GMT x-fapi-customer-ip-address: 104.25.212.99 x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460d Accept: application/json |
Response
HTTP/1.1 200 OK x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460d Content-Type: application/json { "Data": { "Party": { "PartyId": "PABC123", "PartyType": "Sole", "Name": "Semiotec", "Email": "contact@semiotec.co.jp", "Address": { "AddressType": "Business", "StreetName": "Street", "BuildingNumber": "15", "PostCode": "NW1 1AB", "TownName": "London", "Country": "GB" } } }, "Links": { "Self": "https://api.alphabank.com/open-banking/v3.1/aisp/accounts/22289/party/" }, "Meta": { "TotalPages": 1 } } |
Request
GET /party HTTP/1.1 Authorization: Bearer Az90SAOJklae x-fapi-financial-id: OB/2017/001 x-fapi-customer-last-logged-time: Sun, 10 Sep 2017 19:43:31 GMT x-fapi-customer-ip-address: 104.25.212.99 x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460d Accept: application/json |
Response
HTTP/1.1 200 OK x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460d Content-Type: application/json { "Data": { "Party": { "PartyId": "PXSIF023", "PartyType": "Delegate", "Name": "Mr D User", "Email": "d.user@semiotec.co.jp" } }, "Links": { "Self": "https://api.alphabank.com/open-banking/v3.1/aisp/party/" }, "Meta": { "TotalPages": 1 } } |