Sorry, you need to enable JavaScript to visit this website.
Skip to main content
developer.sibsapimarket.com/sandbox

developer.sibsapimarket.com/sandbox

  • Getting started
  • API Documentation
  • Help
Register
  • Welcome
  • Sandbox
  • Test & Production

Attention!

This site isn't fully compatible with Edge and you may find some technical issues. For a better experience, we recommend using Chrome, Firefox or Safari.

  • Client Data 1.0.3
  • APIs
  • IBAN TIN Confirmation 1.0.2
  • Client Name Confirmation 1.0.9
      • Operations
      • POST /{aspsp-cde}/v1/client-data/client-name-confirmation
      • Definitions
      • AccountReference
      • ClientNameRequestResource
      • ClientNameResponseResource
      • ErrorMessageWithStatus
      • MessageCode
      • TppMessage
      • TppMessageArray
      • TransactionStatusType

Client Name Confirmation 1.0.9

0
No votes yet

It is also provided the possibility for your users to receive a name of an accountholder of a certain provided IBAN.

  • cURL
  • Ruby
  • Python
  • PHP
  • Java
  • Node
  • Go
  • Swift
Subscribe
production
development
https://site1.sibsapimarket.com:8445/sibs/apimarket-sb
production
development
https://site2.sibsapimarket.com:8445/sibs/apimarket-sb

Paths

/{aspsp-cde}/v1/client-data/client-name-confirmation

post /{aspsp-cde}/v1/client-data/client-name-confirmation
Client Name Confirmation

Client Name Confirmation

Requests the Client Name associated to a indicated IBAN.

x-ibm-client-id
X-IBM-Client-Id
(apiKey located in header)
ClientNameConfirmationRequest
Required in body
object

Is asking for detailed account information.

{
    "schema": {
        "type": "object",
        "properties": {
            "account": {
                "$ref": "#\/definitions\/AccountReference",
                "description": "Is asking for detailed account information."
            }
        },
        "description": "Is asking for detailed account information.",
        "required": [
            "account"
        ]
    }
}
psuInvolved
Required in query
boolean

It must be contained if the PSU is involved in request process. This flag is then set to "true".

aspsp-cde
Required in path
string

Identification of the aspsp

TPP-Transaction-ID
Required in header
string

ID of the transaction as determined by the initiating party.

TPP-Request-ID
Required in header
string

ID of the request, unique to the call, as determined by the initiating party.

PSU-Agent
Optional in header
string

It should be fulfilled whenever psuInvolved is set to "true". The forwarded Agent header field of the http request between PSU and TPP.

PSU-IP-Address
Optional in header
string

It should be fulfilled whenever psuInvolved is set to "true". The forwarded IP Address header field consists of the corresponding http request IP Address field between PSU and TPP.

PSU-Geo-Location
Optional in header
string

It should be fulfilled whenever psuInvolved is set to "true". The forwarded Geo Location of the corresponding http request between PSU and TPP if available.

PSU-IP-Port
Optional in header
string

It should be fulfilled whenever psuInvolved is set to "true". The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available.

PSU-Device-ID
Optional in header
string

It should be fulfilled whenever psuInvolved is set to "true". UUID (Universally Unique Identifier) for a device, which is used by the PSU, if available. UUID identifies either a device or a device dependant application installation. In case of an installation identification this ID need to be unaltered until removal from device.

PSU-Device-Fingerprint
Optional in header
string

It should be fulfilled whenever psuInvolved is set to "true". Fingerprint of the device used in the request between PSU and TPP, if available.

Digest
Optional in header
string

Hash of the message body. Should be present when Request body exists

{
    "default": ""
}
Date
Optional in header
string / date-time

Request date

{
    "pattern": "yyyy-MM-dd'T'hh:MM:ss.SSS"
}
Content-Type
Optional in header
string
application/json
Accept
Optional in header
string
application/json
200

200 OK

ClientNameResponseResource
400

Bad Request.

ErrorMessageWithStatus
401

Unauthorized.

ErrorMessageWithStatus
403

Forbidden.

ErrorMessageWithStatus
404

Not Found.

ErrorMessageWithStatus
405

Method Not Allowed.

ErrorMessageWithStatus
406

Not Acceptable.

ErrorMessageWithStatus
408

Request Timeout.

ErrorMessageWithStatus
415

Unsupported Media Type.

ErrorMessageWithStatus
429

Too Many Requests.

ErrorMessageWithStatus
500

Internal Server Error.

ErrorMessageWithStatus
503

Service Unavailable.

ErrorMessageWithStatus
504

Gatewaty Timeout.

ErrorMessageWithStatus
Example Request
Show more open_in_new

x
Show more open_in_new

x
Show more open_in_new

x
Show more open_in_new

x
Show more open_in_new

x
Show more open_in_new

x
Show more open_in_new

x
Show more open_in_new

x
Example Response
POST https://site1.sibsapimarket.com:8445/sibs/apimarket-sb/{aspsp-cde}/v1/client-data/client-name-confirmation
Show more open_in_new
                                          
                                        

x
Try this operation
https://site1.sibsapimarket.com:8445/sibs/apimarket-sb/{aspsp-cde}/v1/client-data/client-name-confirmation
Login to test this API.
Login to test this API.
content-type
accept
TPP-Transaction-ID
TPP-Request-ID
PSU-Agent
PSU-IP-Address
PSU-Geo-Location
PSU-IP-Port
PSU-Device-ID
PSU-Device-Fingerprint
Digest
Date
psuInvolved
aspsp-cde

                        
No response. This is a mixed content call. It is not possible to test HTTP APIs from an HTTPS secured Portal site and vice versa. No response. This is a cross-origin call. Make sure the server accepts requests from this portal. Or if using self-signed SSL certificates then paste the URL above into your browser to accept the certificate before trying again (On Internet Explorer it must be the same browser tab.).

                            

Definitions

Identifier of the addressed account.

{
    "type": "object",
    "properties": {
        "iban": {
            "description": "International Bank Account Number",
            "type": "string",
            "pattern": "^[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}$",
            "default": "PT000"
        },
        "bban": {
            "description": "This data elements is used for payment accounts which have no IBAN.",
            "type": "string",
            "default": "1",
            "pattern": "^[a-zA-Z0-9]{1,30}$"
        },
        "pan": {
            "description": "Primary Account Number (PAN) of a card, can be tokenised by the ASPSP due to PCI DSS requirements.",
            "type": "string",
            "maxLength": 35,
            "default": ""
        },
        "maskedPan": {
            "description": "Primary Account Number (PAN) of a card in a masked form.",
            "type": "string",
            "maxLength": 35,
            "default": ""
        },
        "msisdn": {
            "description": "An alias to access a payment account via a registered mobile phone number",
            "type": "string",
            "maxLength": 35,
            "default": ""
        },
        "currency": {
            "description": "ISO 4217 Alpha 3 currency code.",
            "type": "string",
            "default": ""
        }
    },
    "additionalProperties": false,
    "required": [
        "iban"
    ]
}
              

Is asking for detailed account information.

{
    "type": "object",
    "properties": {
        "account": {
            "$ref": "#/definitions/AccountReference",
            "description": "Is asking for detailed account information."
        }
    },
    "required": [
        "account"
    ]
}
              
{
    "properties": {
        "transactionStatus": {
            "description": "Status",
            "$ref": "#/definitions/TransactionStatusType"
        },
        "clientName": {
            "type": "string",
            "description": "Client name"
        }
    },
    "additionalProperties": false,
    "required": [
        "transactionStatus"
    ]
}
              

Error and status Information.

{
    "type": "object",
    "properties": {
        "transactionStatus": {
            "$ref": "#/definitions/TransactionStatusType",
            "description": "The transaction status is filled with codes of the ISO 20022 corresponding element."
        },
        "tppMessages": {
            "$ref": "#/definitions/TppMessageArray",
            "description": "Messages to the TPP on operational issues."
        }
    },
    "additionalProperties": false
}
              

Message error codes.

{
    "type": "string",
    "enum": [
        "SERVICE_BLOCKED",
        "CORPORATE_ID_IVALID",
        "CONSENT_UNKNOWN",
        "CONSENT_INVALID",
        "CONSENT_EXPIRED",
        "RESOURCE_UNIKNOWN",
        "RESOURCE_EXPIRED",
        "TIMESTAMP_INVALID",
        "PERIOD_INVALID",
        "TRANSACTION_ID_INVALID",
        "PRODUCT_INVALID",
        "PRODUCT_UNKNOWN",
        "REQUIRED_KID_MISSING",
        "SESSIONS_NOT_SUPPORTED",
        "ACCESS_EXCEEDED",
        "REQUESTED_FORMATS_INVALID"
    ],
    "additionalProperties": false
}
              

Transports additional error information.

{
    "required": [
        "category",
        "code"
    ],
    "properties": {
        "category": {
            "type": "string",
            "default": "",
            "description": "Only ”ERROR” or \"WARNING\" permitted"
        },
        "code": {
            "$ref": "#/definitions/MessageCode",
            "description": "Message error code."
        },
        "path": {
            "type": "string",
            "default": "",
            "description": "Path of the element of the request message which provoked this error message."
        },
        "text": {
            "type": "string",
            "maxLength": 512,
            "default": "",
            "description": "Additional explaining text."
        }
    },
    "additionalProperties": false
}
              

Messages to the TPP on operational issues.

{
    "type": "array",
    "items": {
        "$ref": "#/definitions/TppMessage",
        "description": "Transports additional error information."
    }
}
              

ISO20022: The transaction status is filled with value of the ISO20022 data table.

{
    "type": "string",
    "enum": [
        "ACTC",
        "RJCT"
    ],
    "default": "RJCT",
    "additionalProperties": false
}
              
  • Share this

WELCOME

API Products
API Providers
About Us
PSD2

 

SANDBOX

Getting Started
API Documentation

TEST & PRODUCTION

Getting Started

FAQS & SUPPORT

Developers Forum
FAQs
Contact Us
Check out our LinkedIn


Find more about SIBS
www.sibs.com

©SIBS API Market

Login

User login

Use your developer.sibsapimarket.com/sandbox account ...

  • Create new account
  • Request new password