Skip to main content

Frequently Asked Questions

General​

What is the YAPU API?​

The YAPU API is a REST-based integration layer that allows client financial institutions and their systems to exchange data with the YAPU platform. It supports use cases such as submitting questionnaire data, retrieving reports, checking client eligibility, and more.

Do I need a contract to start an API integration?​

Yes. All YAPU API integrations require an active contract. The delivery process begins after contract signature. Contact your YAPU representative to start the conversation.

Is YAPU SNAP the same as the standard API bundles?​

No. YAPU SNAP is a standalone API — it operates independently and does not require any other YAPU API or platform context. The standard API bundles are non-standalone and depend on the YAPU platform ecosystem. See YAPU SNAP and API Bundles for more details.

Can I use more than one API bundle?​

Yes. Some integration scenarios involve multiple bundles used together. Your YAPU contact will help identify the right combination during the specification phase.

Technical requirements​

What programming language or platform does YAPU require?​

None specific. YAPU APIs are standard REST APIs over HTTPS with JSON. Any platform or language that can make HTTPS requests and parse JSON can integrate with YAPU.

Does YAPU support static IP communication?​

No. YAPU supports dynamic IP communication only. Static IP whitelisting is not supported. If your infrastructure has specific requirements around this, discuss it with your YAPU contact before the specification phase.

Does YAPU support HTTP (non-encrypted)?​

No. All communication must happen over HTTPS. HTTP requests are not accepted.

What format does YAPU use for API requests?​

All YAPU API requests are single JSON requests over HTTPS. There are no multi-part or batch request formats in standard bundles.

YAPU returns data as strings — what does that mean?​

YAPU's outgoing data (from YAPU to your system) is provided as string values. Your development team is responsible for parsing and converting these strings into the appropriate data types for your application (e.g., numbers, dates, booleans).

Authentication​

How do I get API credentials?​

Credentials are provided by your YAPU contact during the onboarding and specification phase. They are never published in this portal.

Are staging and production credentials the same?​

No. Staging and production environments have separate credentials. Never use staging credentials in production or vice versa.

What should I do if I think my credentials were compromised?​

Contact your YAPU representative immediately. See Support & Contact for escalation contacts.

Integration process​

How long does a YAPU API integration take?​

A typical integration takes between 4 and 13 weeks from contract signature:

  • Specification: 1–3 weeks
  • Development: 2–8 weeks
  • Testing: 1–2 weeks

The development phase varies depending on YAPU's internal prioritization and your team's development speed.

Who creates the technical API documentation?​

YAPU creates the technical API documentation during the specification phase. Both parties must agree on it before development begins.

Do I need to do anything before the specification call?​

It helps to have clarity on:

  • What business process the integration should support
  • What data your system currently holds and what format it is in
  • What your system needs to receive from YAPU

Review the API Bundles overview beforehand to identify which use case fits your needs.

Can I start development before the specification is agreed?​

It is strongly recommended not to start development before the technical documentation is mutually agreed. Starting early without an agreed spec is a common cause of rework and delays.

Data and formats​

What data format does YAPU require for incoming data?​

YAPU requires incoming data to follow YAPU-specific formats defined for each API bundle. These formats are documented in the technical API documentation provided during the specification phase.

Can YAPU adapt to our data format?​

The specification phase includes a data alignment process where YAPU guides the client through defining the required fields and formats. The goal is to reach an agreed format before development begins.

Support​

Who do I contact if I have a technical question during integration?​

Your assigned YAPU Customer Success or Digitalization team representative is your primary point of contact. See Support & Contact for contact options.

Is there a support process after go-live?​

Yes. After go-live, a stabilization period is in place during which YAPU monitors the integration and remains available for escalation. See Testing & Go-Live for details.