Phoenix Locates

SOAP
API Status: Live
Domain(s):
  • Global Markets

Connectivity over SOAP to clients. This allows for non-file based clients submission of locates.

Allows for non-file based clients submission of locates (Connectivity over SOAP)

 

API Access :

Endpoint

 
https://api-mtls.sandbox.cib.bnpparibas.com/gm-phoenix-locates/v1/?apiKey=<consumer_api_key>
WSDL  PhoenixLocates.wsdl
 

Security : 

Key verification

On-boarded consumers with approved API Key
Mutual TLS authentication

Client certificate provided at consumer on-boarding

 

Supported Calls:

getLocates:

Request locates by providing required details. ClientRequestID is auto-generated if not provided and returned in the acknowledgement message to be used to poll for locates response.

Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://service.ws.locatesws.sl.bnpparibas.com/">

   <soapenv:Header/>

   <soapenv:Body>

      <ser:getLocates>

         <arg0>

            <clientRequestID>4def41e7-c6aa-4689-a131-24ad8f8e5d74</clientRequestID>

            <customer>demo</customer>

            <market>US</market>

            <details>

               <requestQuantity>10</requestQuantity>

               <securityID>F.N</securityID>

               <securityIDSource>RICCode</securityIDSource>

            </details>

            <details>

               <requestQuantity>10</requestQuantity>

               <securityID>BLU.TO</securityID>

               <securityIDSource>RICCode</securityIDSource>

            </details>

            <details>

               <requestQuantity>10</requestQuantity>

               <securityID>IBM.N</securityID>

               <securityIDSource>RICCode</securityIDSource>

            </details>

         </arg0>

      </ser:getLocates>

   </soapenv:Body>

</soapenv:Envelope>

Response

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">

    <soap:Body>

        <ns1:getLocatesResponse xmlns:ns1="http://service.ws.locatesws.sl.bnpparibas.com/">

            <return xmlns="">

                <clientRequestID>a677625c-0871-4240-9871-76bbfd693bea</clientRequestID>

                <customer>HbIraJHkXw4HoEVGGuIRhGmLcriV7eXA</customer>

                <market>US</market>

                <status>0</status>

            </return>

        </ns1:getLocatesResponse>

    </soap:Body>

</soap:Envelope>

Error

 
<faultcode>soap:Server</faultcode>
<faultstring>Fault occurred while processing.</faultstring>

Attribute

Description
clientRequestID client locate request identifier
customer consumer API key
details request details
market two-character ISO country code
requestQuantity requested quantity
securityID security identifier
securityIDSource security identifier source
status request status; 0 for success

'poll':

Poll for locate response by providing key details.

Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://service.ws.locatesws.sl.bnpparibas.com/">

   <soapenv:Header/>

   <soapenv:Body>

      <ser:poll>

         <arg0>

            <clientRequestID>4def41e7-c6aa-4689-a131-24ad8f8e5d74</clientRequestID>

            <customer>demo</customer>

            <market>US</market>

         </arg0>

      </ser:poll>

   </soapenv:Body>

</soapenv:Envelope>

Response

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">

    <soap:Body>

        <ns1:pollResponse xmlns:ns1="http://service.ws.locatesws.sl.bnpparibas.com/">

            <return xmlns="">

                <!-- API Key -->

                <customer>AGeGEqX7twYPHG1IzgDMy3JK0MTWCSgT</customer>

                <!-- getLocates request UUID -->

                <clientRequestID>cb7dea7d-ab44-11e4-9723-0025b3afd3a14</clientRequestID>

                <market>US</market>

                <dbLocateID>5396</dbLocateID>

                <locateCount>2</locateCount>

                <responseTimestamp>2021-05-12T10:54:49.961-04:00</responseTimestamp>

                <details>

                    <securityIDSource>RICCode</securityIDSource>

                    <securityID>T.N</securityID>

                    <requestQuantity>15</requestQuantity>

                    <approvedQuantity>15</approvedQuantity>

                    <clientSecurityID>T.N</clientSecurityID>

                    <fee>0.0</fee>

                    <executionPlatform>SwapPB</executionPlatform>

                </details>

                <details>

                    <securityIDSource>RICCode</securityIDSource>

                    <securityID>IBM.N</securityID>

                    <requestQuantity>15</requestQuantity>

                    <approvedQuantity>15</approvedQuantity>

                    <clientSecurityID>IBM.N</clientSecurityID>

                    <fee>0.0</fee>

                    <executionPlatform>SwapPB</executionPlatform>

                </details>

            </return>

        </ns1:pollResponse>

    </soap:Body>

</soap:Envelope>

Error

 
<faultcode>soap:Server</faultcode>
<faultstring>Fault occurred while processing.</faultstring>

Attribute

Description
approvedQuantity approved quantity
clientRequestID client locate request identifier
clientSecurityID client security identifier
customer consumer API key
dbLocateID internal locate request identifier
details response details
executionPlatform internal execution platform
fee fee
locateCount number of locate items in the request
market two-character ISO country code
rebate rebate
requestQuantity requested quantity
responseTimestamp response timestamp UTC
securityID security identifier
securityIDSource security identifier source

 

'received':

Confirm receipt of locate response.

Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://service.ws.locatesws.sl.bnpparibas.com/">

   <soapenv:Header/>

   <soapenv:Body>

      <ser:received>

         <arg0>

            <clientRequestID>4def41e7-c6aa-4689-a131-24ad8f8e5d74</clientRequestID>

            <customer>demo</customer>

            <market>US</market>

         </arg0>

      </ser:received>

   </soapenv:Body>

</soapenv:Envelope>
Response

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">

    <soap:Body>

        <ns1:receivedResponse xmlns:ns1="http://service.ws.locatesws.sl.bnpparibas.com/">

            <return xmlns="">

                <!-- API Key -->

                <customer>AGeGEqX7twYPHG1IzgDMy3JK0MTWCSgT</customer>

                <!-- getLocates request UUID -->

                <clientRequestID>cb7dea7d-ab44-11e4-9723-0025b3afd3a14</clientRequestID>

                <market>US</market>

                <locateCount>2</locateCount>

            </return>

        </ns1:receivedResponse>

    </soap:Body>

</soap:Envelope>
Error  
<faultcode>soap:Server</faultcode>
<faultstring>Fault occurred while processing.</faultstring>

Attribute

Description
clientRequestID client locate request identifier
customer consumer API key
market two-character ISO country code
locateCount number of impacted locate items

About us

BNP Paribas CIB is a leading global financial services firm, offering you solutions in capital markets, securities services, advisory, finance and treasury

 

group2

Contact

Corporate and Institutional Banking at a glance