RetrievalService Web Service

RetrievalService

Click here for a complete list of operations.

RetrieveFacsimile

Retrieve Facsimile method.

Test

The test form is only available for requests from the local machine.

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /public/pws/webservices/retrievalservice.asmx HTTP/1.1
Host: cdr.ffiec.gov
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://cdr.ffiec.gov/public/services/RetrieveFacsimile"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <RetrieveFacsimile xmlns="http://cdr.ffiec.gov/public/services">
      <dataSeries>Call</dataSeries>
      <reportingPeriodEndDate>string</reportingPeriodEndDate>
      <fiIDType>ID_RSSD or FDICCertNumber or OCCChartNumber or OTSDockNumber</fiIDType>
      <fiID>int</fiID>
      <facsimileFormat>PDF or XBRL or SDF</facsimileFormat>
    </RetrieveFacsimile>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <RetrieveFacsimileResponse xmlns="http://cdr.ffiec.gov/public/services">
      <RetrieveFacsimileResult>base64Binary</RetrieveFacsimileResult>
    </RetrieveFacsimileResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /public/pws/webservices/retrievalservice.asmx HTTP/1.1
Host: cdr.ffiec.gov
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <RetrieveFacsimile xmlns="http://cdr.ffiec.gov/public/services">
      <dataSeries>Call</dataSeries>
      <reportingPeriodEndDate>string</reportingPeriodEndDate>
      <fiIDType>ID_RSSD or FDICCertNumber or OCCChartNumber or OTSDockNumber</fiIDType>
      <fiID>int</fiID>
      <facsimileFormat>PDF or XBRL or SDF</facsimileFormat>
    </RetrieveFacsimile>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <RetrieveFacsimileResponse xmlns="http://cdr.ffiec.gov/public/services">
      <RetrieveFacsimileResult>base64Binary</RetrieveFacsimileResult>
    </RetrieveFacsimileResponse>
  </soap12:Body>
</soap12:Envelope>