Interface for interaction between Mojaloop's Account Lookup Service(ALS) and an Oracle Registry Service

Version: 1.0

Based on Mojaloop API Definition. More information can be found at mojaloop.io

Schemes:

Summary

Tag: participants

Operation Description
POST /participants/{Type}/{ID}

Create participant information
GET /participants/{Type}/{ID}

Look up participant information
PUT /participants/{Type}/{ID}

Update participant information
DELETE /participants/{Type}/{ID}

Delete participant information
POST /participants/{Type}/{ID}/{SubId}

Create participant information
GET /participants/{Type}/{ID}/{SubId}

Look up participant information
PUT /participants/{Type}/{ID}/{SubId}

Update participant information
DELETE /participants/{Type}/{ID}/{SubId}

Delete participant information
POST /participants

Create bulk participant information

Tag: health

Operation Description
GET /health

Get Server

Tag: metrics

Operation Description
GET /metrics

Prometheus metrics endpoint

Paths

Get Server

GET /health

Tags: health

The HTTP request GET /health is used to return the current status of the API.

200 OK #/components/responses/200

OK

400 Bad Request #/components/responses/400

Bad Request

Name Description Data Type
Content-Length

The Content-Length header field indicates the anticipated size of the payload body. Only sent if there is a body.

Note: The API supports a maximum size of 5242880 bytes (5 Megabytes).

 object
Content-Type

The Content-Type header indicates the specific version of the API used to send the payload body.

 object
401 Unauthorized #/components/responses/401

Unauthorized

Name Description Data Type
Content-Length

The Content-Length header field indicates the anticipated size of the payload body. Only sent if there is a body.

Note: The API supports a maximum size of 5242880 bytes (5 Megabytes).

 object
Content-Type

The Content-Type header indicates the specific version of the API used to send the payload body.

 object
403 Forbidden #/components/responses/403

Forbidden

Name Description Data Type
Content-Length

The Content-Length header field indicates the anticipated size of the payload body. Only sent if there is a body.

Note: The API supports a maximum size of 5242880 bytes (5 Megabytes).

 object
Content-Type

The Content-Type header indicates the specific version of the API used to send the payload body.

 object
404 Not Found #/components/responses/404

Not Found

Name Description Data Type
Content-Length

The Content-Length header field indicates the anticipated size of the payload body. Only sent if there is a body.

Note: The API supports a maximum size of 5242880 bytes (5 Megabytes).

 object
Content-Type

The Content-Type header indicates the specific version of the API used to send the payload body.

 object
405 Method Not Allowed #/components/responses/405

Method Not Allowed

Name Description Data Type
Content-Length

The Content-Length header field indicates the anticipated size of the payload body. Only sent if there is a body.

Note: The API supports a maximum size of 5242880 bytes (5 Megabytes).

 object
Content-Type

The Content-Type header indicates the specific version of the API used to send the payload body.

 object
406 Not Acceptable #/components/responses/406

Not Acceptable

Name Description Data Type
Content-Length

The Content-Length header field indicates the anticipated size of the payload body. Only sent if there is a body.

Note: The API supports a maximum size of 5242880 bytes (5 Megabytes).

 object
Content-Type

The Content-Type header indicates the specific version of the API used to send the payload body.

 object
501 Not Implemented #/components/responses/501

Not Implemented

Name Description Data Type
Content-Length

The Content-Length header field indicates the anticipated size of the payload body. Only sent if there is a body.

Note: The API supports a maximum size of 5242880 bytes (5 Megabytes).

 object
Content-Type

The Content-Type header indicates the specific version of the API used to send the payload body.

 object
503 Service Unavailable #/components/responses/503

Service Unavailable

Name Description Data Type
Content-Length

The Content-Length header field indicates the anticipated size of the payload body. Only sent if there is a body.

Note: The API supports a maximum size of 5242880 bytes (5 Megabytes).

 object
Content-Type

The Content-Type header indicates the specific version of the API used to send the payload body.

 object
Prometheus metrics endpoint

GET /metrics

Tags: metrics

The HTTP request GET /metrics is used to return metrics for the API.

200 OK #/components/responses/200

OK

400 Bad Request #/components/responses/400

Bad Request

Name Description Data Type
Content-Length

The Content-Length header field indicates the anticipated size of the payload body. Only sent if there is a body.

Note: The API supports a maximum size of 5242880 bytes (5 Megabytes).

 object
Content-Type

The Content-Type header indicates the specific version of the API used to send the payload body.

 object
401 Unauthorized #/components/responses/401

Unauthorized

Name Description Data Type
Content-Length

The Content-Length header field indicates the anticipated size of the payload body. Only sent if there is a body.

Note: The API supports a maximum size of 5242880 bytes (5 Megabytes).

 object
Content-Type

The Content-Type header indicates the specific version of the API used to send the payload body.

 object
403 Forbidden #/components/responses/403

Forbidden

Name Description Data Type
Content-Length

The Content-Length header field indicates the anticipated size of the payload body. Only sent if there is a body.

Note: The API supports a maximum size of 5242880 bytes (5 Megabytes).

 object
Content-Type

The Content-Type header indicates the specific version of the API used to send the payload body.

 object
404 Not Found #/components/responses/404

Not Found

Name Description Data Type
Content-Length

The Content-Length header field indicates the anticipated size of the payload body. Only sent if there is a body.

Note: The API supports a maximum size of 5242880 bytes (5 Megabytes).

 object
Content-Type

The Content-Type header indicates the specific version of the API used to send the payload body.

 object
405 Method Not Allowed #/components/responses/405

Method Not Allowed

Name Description Data Type
Content-Length

The Content-Length header field indicates the anticipated size of the payload body. Only sent if there is a body.

Note: The API supports a maximum size of 5242880 bytes (5 Megabytes).

 object
Content-Type

The Content-Type header indicates the specific version of the API used to send the payload body.

 object
406 Not Acceptable #/components/responses/406

Not Acceptable

Name Description Data Type
Content-Length

The Content-Length header field indicates the anticipated size of the payload body. Only sent if there is a body.

Note: The API supports a maximum size of 5242880 bytes (5 Megabytes).

 object
Content-Type

The Content-Type header indicates the specific version of the API used to send the payload body.

 object
501 Not Implemented #/components/responses/501

Not Implemented

Name Description Data Type
Content-Length

The Content-Length header field indicates the anticipated size of the payload body. Only sent if there is a body.

Note: The API supports a maximum size of 5242880 bytes (5 Megabytes).

 object
Content-Type

The Content-Type header indicates the specific version of the API used to send the payload body.

 object
503 Service Unavailable #/components/responses/503

Service Unavailable

Name Description Data Type
Content-Length

The Content-Length header field indicates the anticipated size of the payload body. Only sent if there is a body.

Note: The API supports a maximum size of 5242880 bytes (5 Megabytes).

 object
Content-Type

The Content-Type header indicates the specific version of the API used to send the payload body.

 object
Create bulk participant information

POST /participants

Tags: participants

The HTTP request POST /participants is used to create information in the server regarding the provided list of identities. This request should be used for bulk creation of FSP information for more than one Party. The optional currency parameter should indicate that each provided Party supports the currency.

201 Created

Created

Name Description Data Type
400 Bad Request #/components/responses/400

Bad Request

Name Description Data Type
Content-Length

The Content-Length header field indicates the anticipated size of the payload body. Only sent if there is a body.

Note: The API supports a maximum size of 5242880 bytes (5 Megabytes).

 object
Content-Type

The Content-Type header indicates the specific version of the API used to send the payload body.

 object
401 Unauthorized #/components/responses/401

Unauthorized

Name Description Data Type
Content-Length

The Content-Length header field indicates the anticipated size of the payload body. Only sent if there is a body.

Note: The API supports a maximum size of 5242880 bytes (5 Megabytes).

 object
Content-Type

The Content-Type header indicates the specific version of the API used to send the payload body.

 object
403 Forbidden #/components/responses/403

Forbidden

Name Description Data Type
Content-Length

The Content-Length header field indicates the anticipated size of the payload body. Only sent if there is a body.

Note: The API supports a maximum size of 5242880 bytes (5 Megabytes).

 object
Content-Type

The Content-Type header indicates the specific version of the API used to send the payload body.

 object
404 Not Found #/components/responses/404

Not Found

Name Description Data Type
Content-Length

The Content-Length header field indicates the anticipated size of the payload body. Only sent if there is a body.

Note: The API supports a maximum size of 5242880 bytes (5 Megabytes).

 object
Content-Type

The Content-Type header indicates the specific version of the API used to send the payload body.

 object
405 Method Not Allowed #/components/responses/405

Method Not Allowed

Name Description Data Type
Content-Length

The Content-Length header field indicates the anticipated size of the payload body. Only sent if there is a body.

Note: The API supports a maximum size of 5242880 bytes (5 Megabytes).

 object
Content-Type

The Content-Type header indicates the specific version of the API used to send the payload body.

 object
406 Not Acceptable #/components/responses/406

Not Acceptable

Name Description Data Type
Content-Length

The Content-Length header field indicates the anticipated size of the payload body. Only sent if there is a body.

Note: The API supports a maximum size of 5242880 bytes (5 Megabytes).

 object
Content-Type

The Content-Type header indicates the specific version of the API used to send the payload body.

 object
501 Not Implemented #/components/responses/501

Not Implemented

Name Description Data Type
Content-Length

The Content-Length header field indicates the anticipated size of the payload body. Only sent if there is a body.

Note: The API supports a maximum size of 5242880 bytes (5 Megabytes).

 object
Content-Type

The Content-Type header indicates the specific version of the API used to send the payload body.

 object
503 Service Unavailable #/components/responses/503

Service Unavailable

Name Description Data Type
Content-Length

The Content-Length header field indicates the anticipated size of the payload body. Only sent if there is a body.

Note: The API supports a maximum size of 5242880 bytes (5 Megabytes).

 object
Content-Type

The Content-Type header indicates the specific version of the API used to send the payload body.

 object
Delete participant information

DELETE /participants/{Type}/{ID}

Tags: participants

The HTTP request DELETE /participants/{Type}/{ID} (or DELETE /participants/{Type}/{ID}/{SubId}) is used to delete information in the server regarding the provided identity, defined by {Type} and {ID}) (for example, DELETE /participants/MSISDN/123456789), and optionally {SubId}. This HTTP request should support a query string to delete FSP information regarding a specific currency only. To delete a specific currency only, the HTTP request DELETE /participants/{Type}/{ID}?currency=XYZ should be used, where XYZ is the requested currency.

Note: The Account Lookup System should verify that it is the Party’s current FSP that is deleting the FSP information.

Name Description Type Data Type Annotation
Type

The type of the party identifier. For example, MSISDN, PERSONAL_ID.

 path object #/components/parameters/Type
ID

The identifier value.

 path object #/components/parameters/ID
204 No Content

No Content

Name Description Data Type
400 Bad Request #/components/responses/400

Bad Request

Name Description Data Type
Content-Length

The Content-Length header field indicates the anticipated size of the payload body. Only sent if there is a body.

Note: The API supports a maximum size of 5242880 bytes (5 Megabytes).

 object
Content-Type

The Content-Type header indicates the specific version of the API used to send the payload body.

 object
401 Unauthorized #/components/responses/401

Unauthorized

Name Description Data Type
Content-Length

The Content-Length header field indicates the anticipated size of the payload body. Only sent if there is a body.

Note: The API supports a maximum size of 5242880 bytes (5 Megabytes).

 object
Content-Type

The Content-Type header indicates the specific version of the API used to send the payload body.

 object
403 Forbidden #/components/responses/403

Forbidden

Name Description Data Type
Content-Length

The Content-Length header field indicates the anticipated size of the payload body. Only sent if there is a body.

Note: The API supports a maximum size of 5242880 bytes (5 Megabytes).

 object
Content-Type

The Content-Type header indicates the specific version of the API used to send the payload body.

 object
404 Not Found #/components/responses/404

Not Found

Name Description Data Type
Content-Length

The Content-Length header field indicates the anticipated size of the payload body. Only sent if there is a body.

Note: The API supports a maximum size of 5242880 bytes (5 Megabytes).

 object
Content-Type

The Content-Type header indicates the specific version of the API used to send the payload body.

 object
405 Method Not Allowed #/components/responses/405

Method Not Allowed

Name Description Data Type
Content-Length

The Content-Length header field indicates the anticipated size of the payload body. Only sent if there is a body.

Note: The API supports a maximum size of 5242880 bytes (5 Megabytes).

 object
Content-Type

The Content-Type header indicates the specific version of the API used to send the payload body.

 object
406 Not Acceptable #/components/responses/406

Not Acceptable

Name Description Data Type
Content-Length

The Content-Length header field indicates the anticipated size of the payload body. Only sent if there is a body.

Note: The API supports a maximum size of 5242880 bytes (5 Megabytes).

 object
Content-Type

The Content-Type header indicates the specific version of the API used to send the payload body.

 object
501 Not Implemented #/components/responses/501

Not Implemented

Name Description Data Type
Content-Length

The Content-Length header field indicates the anticipated size of the payload body. Only sent if there is a body.

Note: The API supports a maximum size of 5242880 bytes (5 Megabytes).

 object
Content-Type

The Content-Type header indicates the specific version of the API used to send the payload body.

 object
503 Service Unavailable #/components/responses/503

Service Unavailable

Name Description Data Type
Content-Length

The Content-Length header field indicates the anticipated size of the payload body. Only sent if there is a body.

Note: The API supports a maximum size of 5242880 bytes (5 Megabytes).

 object
Content-Type

The Content-Type header indicates the specific version of the API used to send the payload body.

 object
Look up participant information

GET /participants/{Type}/{ID}

Tags: participants

The HTTP request GET /participants/{Type}/{ID} (or GET /participants/{Type}/{ID}/{SubId}) is used to find out in which FSP the requested Party, defined by {Type}, {ID} and optionally {SubId}, is located (for example, GET /participants/MSISDN/123456789, or GET /participants/BUSINESS/shoecompany/employee1). This HTTP request should support a query string for filtering of currency. To use filtering of currency, the HTTP request GET /participants/{Type}/{ID}?currency=XYZ should be used, where XYZ is the requested currency.

Name Description Type Data Type Annotation
partySubIdOrType

A sub-identifier of the party identifier, or a sub-type of the party identifier's type. For example, PASSPORT, DRIVING_LICENSE.

 query object #/components/parameters/partySubIdOrType
Type

The type of the party identifier. For example, MSISDN, PERSONAL_ID.

 path object #/components/parameters/Type
ID

The identifier value.

 path object #/components/parameters/ID
200 OK

OK

Name Description Data Type
Content-Length object
400 Bad Request #/components/responses/400

Bad Request

Name Description Data Type
Content-Length

The Content-Length header field indicates the anticipated size of the payload body. Only sent if there is a body.

Note: The API supports a maximum size of 5242880 bytes (5 Megabytes).

 object
Content-Type

The Content-Type header indicates the specific version of the API used to send the payload body.

 object
401 Unauthorized #/components/responses/401

Unauthorized

Name Description Data Type
Content-Length

The Content-Length header field indicates the anticipated size of the payload body. Only sent if there is a body.

Note: The API supports a maximum size of 5242880 bytes (5 Megabytes).

 object
Content-Type

The Content-Type header indicates the specific version of the API used to send the payload body.

 object
403 Forbidden #/components/responses/403

Forbidden

Name Description Data Type
Content-Length

The Content-Length header field indicates the anticipated size of the payload body. Only sent if there is a body.

Note: The API supports a maximum size of 5242880 bytes (5 Megabytes).

 object
Content-Type

The Content-Type header indicates the specific version of the API used to send the payload body.

 object
404 Not Found #/components/responses/404

Not Found

Name Description Data Type
Content-Length

The Content-Length header field indicates the anticipated size of the payload body. Only sent if there is a body.

Note: The API supports a maximum size of 5242880 bytes (5 Megabytes).

 object
Content-Type

The Content-Type header indicates the specific version of the API used to send the payload body.

 object
405 Method Not Allowed #/components/responses/405

Method Not Allowed

Name Description Data Type
Content-Length

The Content-Length header field indicates the anticipated size of the payload body. Only sent if there is a body.

Note: The API supports a maximum size of 5242880 bytes (5 Megabytes).

 object
Content-Type

The Content-Type header indicates the specific version of the API used to send the payload body.

 object
406 Not Acceptable #/components/responses/406

Not Acceptable

Name Description Data Type
Content-Length

The Content-Length header field indicates the anticipated size of the payload body. Only sent if there is a body.

Note: The API supports a maximum size of 5242880 bytes (5 Megabytes).

 object
Content-Type

The Content-Type header indicates the specific version of the API used to send the payload body.

 object
501 Not Implemented #/components/responses/501

Not Implemented

Name Description Data Type
Content-Length

The Content-Length header field indicates the anticipated size of the payload body. Only sent if there is a body.

Note: The API supports a maximum size of 5242880 bytes (5 Megabytes).

 object
Content-Type

The Content-Type header indicates the specific version of the API used to send the payload body.

 object
503 Service Unavailable #/components/responses/503

Service Unavailable

Name Description Data Type
Content-Length

The Content-Length header field indicates the anticipated size of the payload body. Only sent if there is a body.

Note: The API supports a maximum size of 5242880 bytes (5 Megabytes).

 object
Content-Type

The Content-Type header indicates the specific version of the API used to send the payload body.

 object
Create participant information

POST /participants/{Type}/{ID}

Tags: participants

The HTTP request POST /participants/{Type}/{ID} (or POST /participants/{Type}/{ID}/{SubId}) is used to create information in the server regarding the provided identity, defined by {Type}, {ID}, and optionally {SubId} (for example, POST /participants/MSISDN/123456789 or POST /participants/BUSINESS/shoecompany/employee1). An ExtensionList element has been added to this request in version v1.1

Name Description Type Data Type Annotation
Type

The type of the party identifier. For example, MSISDN, PERSONAL_ID.

 path object #/components/parameters/Type
ID

The identifier value.

 path object #/components/parameters/ID
201 Created

Created

Name Description Data Type
400 Bad Request #/components/responses/400

Bad Request

Name Description Data Type
Content-Length

The Content-Length header field indicates the anticipated size of the payload body. Only sent if there is a body.

Note: The API supports a maximum size of 5242880 bytes (5 Megabytes).

 object
Content-Type

The Content-Type header indicates the specific version of the API used to send the payload body.

 object
401 Unauthorized #/components/responses/401

Unauthorized

Name Description Data Type
Content-Length

The Content-Length header field indicates the anticipated size of the payload body. Only sent if there is a body.

Note: The API supports a maximum size of 5242880 bytes (5 Megabytes).

 object
Content-Type

The Content-Type header indicates the specific version of the API used to send the payload body.

 object
403 Forbidden #/components/responses/403

Forbidden

Name Description Data Type
Content-Length

The Content-Length header field indicates the anticipated size of the payload body. Only sent if there is a body.

Note: The API supports a maximum size of 5242880 bytes (5 Megabytes).

 object
Content-Type

The Content-Type header indicates the specific version of the API used to send the payload body.

 object
404 Not Found #/components/responses/404

Not Found

Name Description Data Type
Content-Length

The Content-Length header field indicates the anticipated size of the payload body. Only sent if there is a body.

Note: The API supports a maximum size of 5242880 bytes (5 Megabytes).

 object
Content-Type

The Content-Type header indicates the specific version of the API used to send the payload body.

 object
405 Method Not Allowed #/components/responses/405

Method Not Allowed

Name Description Data Type
Content-Length

The Content-Length header field indicates the anticipated size of the payload body. Only sent if there is a body.

Note: The API supports a maximum size of 5242880 bytes (5 Megabytes).

 object
Content-Type

The Content-Type header indicates the specific version of the API used to send the payload body.

 object
406 Not Acceptable #/components/responses/406

Not Acceptable

Name Description Data Type
Content-Length

The Content-Length header field indicates the anticipated size of the payload body. Only sent if there is a body.

Note: The API supports a maximum size of 5242880 bytes (5 Megabytes).

 object
Content-Type

The Content-Type header indicates the specific version of the API used to send the payload body.

 object
501 Not Implemented #/components/responses/501

Not Implemented

Name Description Data Type
Content-Length

The Content-Length header field indicates the anticipated size of the payload body. Only sent if there is a body.

Note: The API supports a maximum size of 5242880 bytes (5 Megabytes).

 object
Content-Type

The Content-Type header indicates the specific version of the API used to send the payload body.

 object
503 Service Unavailable #/components/responses/503

Service Unavailable

Name Description Data Type
Content-Length

The Content-Length header field indicates the anticipated size of the payload body. Only sent if there is a body.

Note: The API supports a maximum size of 5242880 bytes (5 Megabytes).

 object
Content-Type

The Content-Type header indicates the specific version of the API used to send the payload body.

 object
Update participant information

PUT /participants/{Type}/{ID}

Tags: participants

The PUT /participants/{Type}/{ID} is used to update information in the server regarding the provided identity, defined by {Type} and {ID} (for example, PUT /participants/MSISDN/123456789).

Name Description Type Data Type Annotation
Type

The type of the party identifier. For example, MSISDN, PERSONAL_ID.

 path object #/components/parameters/Type
ID

The identifier value.

 path object #/components/parameters/ID
200 OK #/components/responses/200

OK

400 Bad Request #/components/responses/400

Bad Request

Name Description Data Type
Content-Length

The Content-Length header field indicates the anticipated size of the payload body. Only sent if there is a body.

Note: The API supports a maximum size of 5242880 bytes (5 Megabytes).

 object
Content-Type

The Content-Type header indicates the specific version of the API used to send the payload body.

 object
401 Unauthorized #/components/responses/401

Unauthorized

Name Description Data Type
Content-Length

The Content-Length header field indicates the anticipated size of the payload body. Only sent if there is a body.

Note: The API supports a maximum size of 5242880 bytes (5 Megabytes).

 object
Content-Type

The Content-Type header indicates the specific version of the API used to send the payload body.

 object
403 Forbidden #/components/responses/403

Forbidden

Name Description Data Type
Content-Length

The Content-Length header field indicates the anticipated size of the payload body. Only sent if there is a body.

Note: The API supports a maximum size of 5242880 bytes (5 Megabytes).

 object
Content-Type

The Content-Type header indicates the specific version of the API used to send the payload body.

 object
404 Not Found #/components/responses/404

Not Found

Name Description Data Type
Content-Length

The Content-Length header field indicates the anticipated size of the payload body. Only sent if there is a body.

Note: The API supports a maximum size of 5242880 bytes (5 Megabytes).

 object
Content-Type

The Content-Type header indicates the specific version of the API used to send the payload body.

 object
405 Method Not Allowed #/components/responses/405

Method Not Allowed

Name Description Data Type
Content-Length

The Content-Length header field indicates the anticipated size of the payload body. Only sent if there is a body.

Note: The API supports a maximum size of 5242880 bytes (5 Megabytes).

 object
Content-Type

The Content-Type header indicates the specific version of the API used to send the payload body.

 object
406 Not Acceptable #/components/responses/406

Not Acceptable

Name Description Data Type
Content-Length

The Content-Length header field indicates the anticipated size of the payload body. Only sent if there is a body.

Note: The API supports a maximum size of 5242880 bytes (5 Megabytes).

 object
Content-Type

The Content-Type header indicates the specific version of the API used to send the payload body.

 object
501 Not Implemented #/components/responses/501

Not Implemented

Name Description Data Type
Content-Length

The Content-Length header field indicates the anticipated size of the payload body. Only sent if there is a body.

Note: The API supports a maximum size of 5242880 bytes (5 Megabytes).

 object
Content-Type

The Content-Type header indicates the specific version of the API used to send the payload body.

 object
503 Service Unavailable #/components/responses/503

Service Unavailable

Name Description Data Type
Content-Length

The Content-Length header field indicates the anticipated size of the payload body. Only sent if there is a body.

Note: The API supports a maximum size of 5242880 bytes (5 Megabytes).

 object
Content-Type

The Content-Type header indicates the specific version of the API used to send the payload body.

 object
Delete participant information

DELETE /participants/{Type}/{ID}/{SubId}

Tags: participants

The HTTP request DELETE /participants/{Type}/{ID} (or DELETE /participants/{Type}/{ID}/{SubId}) is used to delete information in the server regarding the provided identity, defined by {Type} and {ID}) (for example, DELETE /participants/MSISDN/123456789), and optionally {SubId}. This HTTP request should support a query string to delete FSP information regarding a specific currency only. To delete a specific currency only, the HTTP request DELETE /participants/{Type}/{ID}?currency=XYZ should be used, where XYZ is the requested currency.

Note: The Account Lookup System should verify that it is the Party’s current FSP that is deleting the FSP information.

Name Description Type Data Type Annotation
Type

The type of the party identifier. For example, MSISDN, PERSONAL_ID.

 path object #/components/parameters/Type
ID

The identifier value.

 path object #/components/parameters/ID
SubId

A sub-identifier of the party identifier, or a sub-type of the party identifier's type. For example, PASSPORT, DRIVING_LICENSE.

 path object #/components/parameters/SubId
204 No Content

No Content

Name Description Data Type
400 Bad Request #/components/responses/400

Bad Request

Name Description Data Type
Content-Length

The Content-Length header field indicates the anticipated size of the payload body. Only sent if there is a body.

Note: The API supports a maximum size of 5242880 bytes (5 Megabytes).

 object
Content-Type

The Content-Type header indicates the specific version of the API used to send the payload body.

 object
401 Unauthorized #/components/responses/401

Unauthorized

Name Description Data Type
Content-Length

The Content-Length header field indicates the anticipated size of the payload body. Only sent if there is a body.

Note: The API supports a maximum size of 5242880 bytes (5 Megabytes).

 object
Content-Type

The Content-Type header indicates the specific version of the API used to send the payload body.

 object
403 Forbidden #/components/responses/403

Forbidden

Name Description Data Type
Content-Length

The Content-Length header field indicates the anticipated size of the payload body. Only sent if there is a body.

Note: The API supports a maximum size of 5242880 bytes (5 Megabytes).

 object
Content-Type

The Content-Type header indicates the specific version of the API used to send the payload body.

 object
404 Not Found #/components/responses/404

Not Found

Name Description Data Type
Content-Length

The Content-Length header field indicates the anticipated size of the payload body. Only sent if there is a body.

Note: The API supports a maximum size of 5242880 bytes (5 Megabytes).

 object
Content-Type

The Content-Type header indicates the specific version of the API used to send the payload body.

 object
405 Method Not Allowed #/components/responses/405

Method Not Allowed

Name Description Data Type
Content-Length

The Content-Length header field indicates the anticipated size of the payload body. Only sent if there is a body.

Note: The API supports a maximum size of 5242880 bytes (5 Megabytes).

 object
Content-Type

The Content-Type header indicates the specific version of the API used to send the payload body.

 object
406 Not Acceptable #/components/responses/406

Not Acceptable

Name Description Data Type
Content-Length

The Content-Length header field indicates the anticipated size of the payload body. Only sent if there is a body.

Note: The API supports a maximum size of 5242880 bytes (5 Megabytes).

 object
Content-Type

The Content-Type header indicates the specific version of the API used to send the payload body.

 object
501 Not Implemented #/components/responses/501

Not Implemented

Name Description Data Type
Content-Length

The Content-Length header field indicates the anticipated size of the payload body. Only sent if there is a body.

Note: The API supports a maximum size of 5242880 bytes (5 Megabytes).

 object
Content-Type

The Content-Type header indicates the specific version of the API used to send the payload body.

 object
503 Service Unavailable #/components/responses/503

Service Unavailable

Name Description Data Type
Content-Length

The Content-Length header field indicates the anticipated size of the payload body. Only sent if there is a body.

Note: The API supports a maximum size of 5242880 bytes (5 Megabytes).

 object
Content-Type

The Content-Type header indicates the specific version of the API used to send the payload body.

 object
Look up participant information

GET /participants/{Type}/{ID}/{SubId}

Tags: participants

The HTTP request GET /participants/{Type}/{ID} (or GET /participants/{Type}/{ID}/{SubId}) is used to find out in which FSP the requested Party, defined by {Type}, {ID} and optionally {SubId}, is located (for example, GET /participants/MSISDN/123456789, or GET /participants/BUSINESS/shoecompany/employee1). This HTTP request should support a query string for filtering of currency. To use filtering of currency, the HTTP request GET /participants/{Type}/{ID}?currency=XYZ should be used, where XYZ is the requested currency.

Name Description Type Data Type Annotation
Type

The type of the party identifier. For example, MSISDN, PERSONAL_ID.

 path object #/components/parameters/Type
ID

The identifier value.

 path object #/components/parameters/ID
SubId

A sub-identifier of the party identifier, or a sub-type of the party identifier's type. For example, PASSPORT, DRIVING_LICENSE.

 path object #/components/parameters/SubId
200 OK

OK

Name Description Data Type
Content-Length object
400 Bad Request #/components/responses/400

Bad Request

Name Description Data Type
Content-Length

The Content-Length header field indicates the anticipated size of the payload body. Only sent if there is a body.

Note: The API supports a maximum size of 5242880 bytes (5 Megabytes).

 object
Content-Type

The Content-Type header indicates the specific version of the API used to send the payload body.

 object
401 Unauthorized #/components/responses/401

Unauthorized

Name Description Data Type
Content-Length

The Content-Length header field indicates the anticipated size of the payload body. Only sent if there is a body.

Note: The API supports a maximum size of 5242880 bytes (5 Megabytes).

 object
Content-Type

The Content-Type header indicates the specific version of the API used to send the payload body.

 object
403 Forbidden #/components/responses/403

Forbidden

Name Description Data Type
Content-Length

The Content-Length header field indicates the anticipated size of the payload body. Only sent if there is a body.

Note: The API supports a maximum size of 5242880 bytes (5 Megabytes).

 object
Content-Type

The Content-Type header indicates the specific version of the API used to send the payload body.

 object
404 Not Found #/components/responses/404

Not Found

Name Description Data Type
Content-Length

The Content-Length header field indicates the anticipated size of the payload body. Only sent if there is a body.

Note: The API supports a maximum size of 5242880 bytes (5 Megabytes).

 object
Content-Type

The Content-Type header indicates the specific version of the API used to send the payload body.

 object
405 Method Not Allowed #/components/responses/405

Method Not Allowed

Name Description Data Type
Content-Length

The Content-Length header field indicates the anticipated size of the payload body. Only sent if there is a body.

Note: The API supports a maximum size of 5242880 bytes (5 Megabytes).

 object
Content-Type

The Content-Type header indicates the specific version of the API used to send the payload body.

 object
406 Not Acceptable #/components/responses/406

Not Acceptable

Name Description Data Type
Content-Length

The Content-Length header field indicates the anticipated size of the payload body. Only sent if there is a body.

Note: The API supports a maximum size of 5242880 bytes (5 Megabytes).

 object
Content-Type

The Content-Type header indicates the specific version of the API used to send the payload body.

 object
501 Not Implemented #/components/responses/501

Not Implemented

Name Description Data Type
Content-Length

The Content-Length header field indicates the anticipated size of the payload body. Only sent if there is a body.

Note: The API supports a maximum size of 5242880 bytes (5 Megabytes).

 object
Content-Type

The Content-Type header indicates the specific version of the API used to send the payload body.

 object
503 Service Unavailable #/components/responses/503

Service Unavailable

Name Description Data Type
Content-Length

The Content-Length header field indicates the anticipated size of the payload body. Only sent if there is a body.

Note: The API supports a maximum size of 5242880 bytes (5 Megabytes).

 object
Content-Type

The Content-Type header indicates the specific version of the API used to send the payload body.

 object
Create participant information

POST /participants/{Type}/{ID}/{SubId}

Tags: participants

The HTTP request POST /participants/{Type}/{ID} (or POST /participants/{Type}/{ID}/{SubId}) is used to create information in the server regarding the provided identity, defined by {Type}, {ID}, and optionally {SubId} (for example, POST /participants/MSISDN/123456789 or POST /participants/BUSINESS/shoecompany/employee1). An ExtensionList element has been added to this request in version v1.1

Name Description Type Data Type Annotation
Type

The type of the party identifier. For example, MSISDN, PERSONAL_ID.

 path object #/components/parameters/Type
ID

The identifier value.

 path object #/components/parameters/ID
SubId

A sub-identifier of the party identifier, or a sub-type of the party identifier's type. For example, PASSPORT, DRIVING_LICENSE.

 path object #/components/parameters/SubId
201 Created

Created

Name Description Data Type
400 Bad Request #/components/responses/400

Bad Request

Name Description Data Type
Content-Length

The Content-Length header field indicates the anticipated size of the payload body. Only sent if there is a body.

Note: The API supports a maximum size of 5242880 bytes (5 Megabytes).

 object
Content-Type

The Content-Type header indicates the specific version of the API used to send the payload body.

 object
401 Unauthorized #/components/responses/401

Unauthorized

Name Description Data Type
Content-Length

The Content-Length header field indicates the anticipated size of the payload body. Only sent if there is a body.

Note: The API supports a maximum size of 5242880 bytes (5 Megabytes).

 object
Content-Type

The Content-Type header indicates the specific version of the API used to send the payload body.

 object
403 Forbidden #/components/responses/403

Forbidden

Name Description Data Type
Content-Length

The Content-Length header field indicates the anticipated size of the payload body. Only sent if there is a body.

Note: The API supports a maximum size of 5242880 bytes (5 Megabytes).

 object
Content-Type

The Content-Type header indicates the specific version of the API used to send the payload body.

 object
404 Not Found #/components/responses/404

Not Found

Name Description Data Type
Content-Length

The Content-Length header field indicates the anticipated size of the payload body. Only sent if there is a body.

Note: The API supports a maximum size of 5242880 bytes (5 Megabytes).

 object
Content-Type

The Content-Type header indicates the specific version of the API used to send the payload body.

 object
405 Method Not Allowed #/components/responses/405

Method Not Allowed

Name Description Data Type
Content-Length

The Content-Length header field indicates the anticipated size of the payload body. Only sent if there is a body.

Note: The API supports a maximum size of 5242880 bytes (5 Megabytes).

 object
Content-Type

The Content-Type header indicates the specific version of the API used to send the payload body.

 object
406 Not Acceptable #/components/responses/406

Not Acceptable

Name Description Data Type
Content-Length

The Content-Length header field indicates the anticipated size of the payload body. Only sent if there is a body.

Note: The API supports a maximum size of 5242880 bytes (5 Megabytes).

 object
Content-Type

The Content-Type header indicates the specific version of the API used to send the payload body.

 object
501 Not Implemented #/components/responses/501

Not Implemented

Name Description Data Type
Content-Length

The Content-Length header field indicates the anticipated size of the payload body. Only sent if there is a body.

Note: The API supports a maximum size of 5242880 bytes (5 Megabytes).

 object
Content-Type

The Content-Type header indicates the specific version of the API used to send the payload body.

 object
503 Service Unavailable #/components/responses/503

Service Unavailable

Name Description Data Type
Content-Length

The Content-Length header field indicates the anticipated size of the payload body. Only sent if there is a body.

Note: The API supports a maximum size of 5242880 bytes (5 Megabytes).

 object
Content-Type

The Content-Type header indicates the specific version of the API used to send the payload body.

 object
Update participant information

PUT /participants/{Type}/{ID}/{SubId}

Tags: participants

The PUT /participants/{Type}/{ID}/{SubId} is used to update information in the server regarding the provided identity, defined by {Type}, {ID} and {SubId} (for example, PUT /participants/MSISDN/123456789/PERSONAL).

Name Description Type Data Type Annotation
Type

The type of the party identifier. For example, MSISDN, PERSONAL_ID.

 path object #/components/parameters/Type
ID

The identifier value.

 path object #/components/parameters/ID
SubId

A sub-identifier of the party identifier, or a sub-type of the party identifier's type. For example, PASSPORT, DRIVING_LICENSE.

 path object #/components/parameters/SubId
200 OK #/components/responses/200

OK

400 Bad Request #/components/responses/400

Bad Request

Name Description Data Type
Content-Length

The Content-Length header field indicates the anticipated size of the payload body. Only sent if there is a body.

Note: The API supports a maximum size of 5242880 bytes (5 Megabytes).

 object
Content-Type

The Content-Type header indicates the specific version of the API used to send the payload body.

 object
401 Unauthorized #/components/responses/401

Unauthorized

Name Description Data Type
Content-Length

The Content-Length header field indicates the anticipated size of the payload body. Only sent if there is a body.

Note: The API supports a maximum size of 5242880 bytes (5 Megabytes).

 object
Content-Type

The Content-Type header indicates the specific version of the API used to send the payload body.

 object
403 Forbidden #/components/responses/403

Forbidden

Name Description Data Type
Content-Length

The Content-Length header field indicates the anticipated size of the payload body. Only sent if there is a body.

Note: The API supports a maximum size of 5242880 bytes (5 Megabytes).

 object
Content-Type

The Content-Type header indicates the specific version of the API used to send the payload body.

 object
404 Not Found #/components/responses/404

Not Found

Name Description Data Type
Content-Length

The Content-Length header field indicates the anticipated size of the payload body. Only sent if there is a body.

Note: The API supports a maximum size of 5242880 bytes (5 Megabytes).

 object
Content-Type

The Content-Type header indicates the specific version of the API used to send the payload body.

 object
405 Method Not Allowed #/components/responses/405

Method Not Allowed

Name Description Data Type
Content-Length

The Content-Length header field indicates the anticipated size of the payload body. Only sent if there is a body.

Note: The API supports a maximum size of 5242880 bytes (5 Megabytes).

 object
Content-Type

The Content-Type header indicates the specific version of the API used to send the payload body.

 object
406 Not Acceptable #/components/responses/406

Not Acceptable

Name Description Data Type
Content-Length

The Content-Length header field indicates the anticipated size of the payload body. Only sent if there is a body.

Note: The API supports a maximum size of 5242880 bytes (5 Megabytes).

 object
Content-Type

The Content-Type header indicates the specific version of the API used to send the payload body.

 object
501 Not Implemented #/components/responses/501

Not Implemented

Name Description Data Type
Content-Length

The Content-Length header field indicates the anticipated size of the payload body. Only sent if there is a body.

Note: The API supports a maximum size of 5242880 bytes (5 Megabytes).

 object
Content-Type

The Content-Type header indicates the specific version of the API used to send the payload body.

 object
503 Service Unavailable #/components/responses/503

Service Unavailable

Name Description Data Type
Content-Length

The Content-Length header field indicates the anticipated size of the payload body. Only sent if there is a body.

Note: The API supports a maximum size of 5242880 bytes (5 Megabytes).

 object
Content-Type

The Content-Type header indicates the specific version of the API used to send the payload body.

 object

results matching ""

    No results matching ""