Syniverse Developer Community - Gateway Services

Accounts

Accounts are used to manage all the funds in the Syniverse Developer Community. Accounts can have two statuses: prepay and postpay. Prepay accounts are funded by using a Credit Card. Postpay accounts are billed in monthly intervals. Postpay accounts require approval from Syniverse and you need to have a valid business in the US with a TaxID. Please connect through the Help button to receive more information.

Are you tax-exempt?

If your organization is 501(c)3 tax-exempt or have other tax exemptions within the state you operate from, please connect through the Help button and we will guide you on how to provide us with the proper proof of tax exempt status.

/accounts get post

get

Obtains a list of accounts associated with this company

post

Create a new account

Obtains a list of accounts associated with this company

Response

HTTP status code 200

Successful response

Body

Type: application/json

Schema:

{"type":"object","$schema":"http://json-schema.org/draft-03/schema#","title":"Account"}

Example:

[{"currentMonthTopups":null,"restricted":false,"serviceOfferings":[],"type":"sample type","currentMonthFunds":null,"id":1,"availableFunds":null,"name":"sample name","active":false,"applications":[],"billingAddressId":1,"trial":false,"lastMonthBalance":null,"currentMonthUsage":null}]

HTTP status code 400

Bad Request

Body

Type: application/json

Example:

{"userMsg":"sample userMsg","moreInfoUrl":"sample moreInfoUrl","errorCode":1,"moreInfo":"sample moreInfo"}

Create a new account

Request
Response

Body

Type: application/json

Schema:

{"type":"object","$schema":"http://json-schema.org/draft-03/schema#","title":"Account"}

Example:

{"currentMonthTopups":null,"restricted":false,"serviceOfferings":[],"type":"sample type","currentMonthFunds":null,"id":1,"availableFunds":null,"name":"sample name","active":false,"applications":[],"billingAddressId":1,"trial":false,"lastMonthBalance":null,"currentMonthUsage":null}

HTTP status code 200

Successful response

HTTP status code 400

Bad Request

Body

Type: application/json

Example:

{"userMsg":"sample userMsg","moreInfoUrl":"sample moreInfoUrl","errorCode":1,"moreInfo":"sample moreInfo"}

AccountsID

/accounts/{ID} get delete

get

Get the specified account

delete

Delete the specified account

Get the specified account

Request
Response

URI Parameters

ID: (integer)
ID of referenced account

HTTP status code 200

Successful response

Body

Type: application/json

Schema:

{"type":"object","$schema":"http://json-schema.org/draft-03/schema#","title":"Account"}

Example:

{"currentMonthTopups":null,"restricted":false,"serviceOfferings":[],"type":"sample type","currentMonthFunds":null,"id":1,"availableFunds":null,"name":"sample name","active":false,"applications":[],"billingAddressId":1,"trial":false,"lastMonthBalance":null,"currentMonthUsage":null}

HTTP status code 400

Bad request

Body

Type: application/json

Example:

{"userMsg":"sample userMsg","moreInfoUrl":"sample moreInfoUrl","errorCode":1,"moreInfo":"sample moreInfo"}

Delete the specified account

Request
Response

URI Parameters

ID: (integer)
ID of referenced account

HTTP status code 200

Successful response

HTTP status code 400

Bad Request

Body

Type: application/json

Example:

{"userMsg":"sample userMsg","moreInfoUrl":"sample moreInfoUrl","errorCode":1,"moreInfo":"sample moreInfo"}

AccountsIDBillingaddress

/accounts/{ID}/billing-address post

post

Update the billing address associated with an account

Request
Response

URI Parameters

ID: (integer)
ID of the account

Body

Type: application/json

Schema:

{"type":"object","$schema":"http://json-schema.org/draft-03/schema#","title":"Account"}

Example:

{"currentMonthTopups":null,"restricted":false,"serviceOfferings":[],"type":"sample type","currentMonthFunds":null,"id":1,"availableFunds":null,"name":"sample name","active":false,"applications":[],"billingAddressId":1,"trial":false,"lastMonthBalance":null,"currentMonthUsage":null}

HTTP status code 200

Successful response

HTTP status code 400

Bad request

Body

Type: application/json

Example:

{"userMsg":"sample userMsg","moreInfoUrl":"sample moreInfoUrl","errorCode":1,"moreInfo":"sample moreInfo"}

AccountsIDEntitlements

/accounts/{ID}/entitlements get

get

Get the entitlements associated with an account

Request
Response

URI Parameters

ID: (integer)
Account ID

HTTP status code 200

Successful response

Body

Type: application/json

Schema:

{"type":"object","$schema":"http://json-schema.org/draft-03/schema#","title":"Entitlements","properties":{"userId":{"type":"string","required":false,"title":"userId"},"action":{"type":"string","required":false,"title":"action"},"entitlement":{"type":"string","required":false,"title":"entitlement"},"resourceGroupId":{"type":"string","required":false,"title":"resourceGroupId"}}}

Example:

["entitlement_1","some_other_entitlement","entitlement_2"]

HTTP status code 400

Bad request

Body

Type: application/json

Example:

{"userMsg":"sample userMsg","moreInfoUrl":"sample moreInfoUrl","errorCode":1,"moreInfo":"sample moreInfo"}

AccountsIDRename

/accounts/{ID}/rename post

post

Rename an account

Request
Response

URI Parameters

ID: (integer)
Account ID

Body

Type: application/json

Schema:

{"type":"object","$schema":"http://json-schema.org/draft-03/schema#","title":"Account"}

Example:

{"currentMonthTopups":null,"restricted":false,"serviceOfferings":[],"type":"sample type","currentMonthFunds":null,"id":1,"availableFunds":null,"name":"sample name","active":false,"applications":[],"billingAddressId":1,"trial":false,"lastMonthBalance":null,"currentMonthUsage":null}

HTTP status code 200

Successful response

HTTP status code 400

Bad request

Body

Type: application/json

Example:

{"userMsg":"sample userMsg","moreInfoUrl":"sample moreInfoUrl","errorCode":1,"moreInfo":"sample moreInfo"}

AccountsIDResources

/accounts/{ID}/resources get

get

Get resources associated with an account

Request
Response

URI Parameters

ID: (integer)
Account ID

HTTP status code 200

Successful response

Body

Type: application/json

Schema:

{"type":"object","$schema":"http://json-schema.org/draft-03/schema#","title":"ApiResourceGroup"}

Example:

[{"apiResources":[],"resourceGroupName":"sample resourceGroupName","resourceGroupId":1}]

HTTP status code 400

Bad request

Body

Type: application/json

Example:

{"userMsg":"sample userMsg","moreInfoUrl":"sample moreInfoUrl","errorCode":1,"moreInfo":"sample moreInfo"}

AccountsIDRestrict

/accounts/{ID}/restrict post

post

Restrict a specific account

Request
Response

URI Parameters

ID: (integer)
Account ID

HTTP status code 200

Successful reponse

HTTP status code 400

Bad request

Body

Type: application/json

Example:

{"userMsg":"sample userMsg","moreInfoUrl":"sample moreInfoUrl","errorCode":1,"moreInfo":"sample moreInfo"}

AccountsIDTopup

/accounts/{ID}/top-up post

post

Top up an account

Request
Response

URI Parameters

ID: (integer)
Account ID

Body

Type: application/json

Schema:

{"type":"object","$schema":"http://json-schema.org/draft-03/schema#","title":"TopupPayload","properties":{"amount":{"type":"string","required":false,"title":"amount"},"paymentMethodId":{"type":"integer","required":false,"title":"paymentMethodId"}}}

Example:

{"amount":"sample amount","paymentMethodId":1}

HTTP status code 200

Successful response

HTTP status code 400

Bad request

Body

Type: application/json

Example:

{"userMsg":"sample userMsg","moreInfoUrl":"sample moreInfoUrl","errorCode":1,"moreInfo":"sample moreInfo"}

AccountsIDUnrestrict

/accounts/{ID}/unrestrict post

post

Unrestrict an account

Request
Response

URI Parameters

ID: (integer)
Account ID

HTTP status code 200

Successful response

HTTP status code 400

Bad request

Body

Type: application/json

Example:

{"userMsg":"sample userMsg","moreInfoUrl":"sample moreInfoUrl","errorCode":1,"moreInfo":"sample moreInfo"}

Applications

Before messages can be sent through the Syniverse Developer portal, applications need to have a service offering and an account attached to them.

Each application comes with a set of authentication keys. These keys are used to validate the application, allowing it to connect with the Syniverse Developer portal and use the service offerings and funds you have configured. To read more about the keys, please go to the Security section.

Any company users can create an application, but they can only delete the applications they created or the applications they have the entitlements to do this for.

/applications get post

get

Returns applications for the caller's company

post

Create a new application

Returns applications for the caller's company

Response

HTTP status code 200

Successful response

Body

Type: application/json

Schema:

{"type":"object","$schema":"http://json-schema.org/draft-03/schema#","title":"Application"}

Example:

[{"id":1,"resources":[1],"description":"sample description","applicationEntitlements":["sample applicationEntitlements"],"name":"sample name","requireUserTokenValidation":false,"Account":null,"productionAuthKey":null,"userEntitlements":[],"creator":null}]

HTTP status code 400

Bad request

Body

Type: application/json

Example:

{"userMsg":"sample userMsg","moreInfoUrl":"sample moreInfoUrl","errorCode":1,"moreInfo":"sample moreInfo"}

Create a new application

Request
Response

Body

Type: application/json

Schema:

{"type":"object","$schema":"http://json-schema.org/draft-03/schema#","title":"Application"}

Example:

{"id":1,"resources":[1],"description":"sample description","applicationEntitlements":["sample applicationEntitlements"],"name":"sample name","requireUserTokenValidation":false,"Account":null,"productionAuthKey":null,"userEntitlements":[],"creator":null}

HTTP status code 200

Successful response

HTTP status code 400

Bad request

Body

Type: application/json

Example:

{"userMsg":"sample userMsg","moreInfoUrl":"sample moreInfoUrl","errorCode":1,"moreInfo":"sample moreInfo"}

ApplicationsID

/applications/{ID} get post

get

Returns a specific application

post

Modify an existing application

Returns a specific application

Request
Response

URI Parameters

ID: (integer)
Application ID

HTTP status code 200

Successful reponse

Body

Type: application/json

Schema:

{"type":"object","$schema":"http://json-schema.org/draft-03/schema#","title":"Application"}

Example:

{"id":1,"resources":[1],"description":"sample description","applicationEntitlements":["sample applicationEntitlements"],"name":"sample name","requireUserTokenValidation":false,"Account":null,"productionAuthKey":null,"userEntitlements":[],"creator":null}

HTTP status code 400

Bad request

Body

Type: application/json

Example:

{"userMsg":"sample userMsg","moreInfoUrl":"sample moreInfoUrl","errorCode":1,"moreInfo":"sample moreInfo"}

Modify an existing application

Request
Response

URI Parameters

ID: (integer)
Application ID

Body

Type: application/json

Schema:

{"type":"object","$schema":"http://json-schema.org/draft-03/schema#","title":"Application"}

Example:

{"id":1,"resources":[1],"description":"sample description","applicationEntitlements":["sample applicationEntitlements"],"name":"sample name","requireUserTokenValidation":false,"Account":null,"productionAuthKey":null,"userEntitlements":[],"creator":null}

HTTP status code 200

Successful response

HTTP status code 400

Bad request

Body

Type: application/json

Example:

{"userMsg":"sample userMsg","moreInfoUrl":"sample moreInfoUrl","errorCode":1,"moreInfo":"sample moreInfo"}

ApplicationsIDAccount

/applications/{ID}/account post

post

Set the account for an application

Request
Response

URI Parameters

ID: (integer)
Application ID

Body

Type: application/json

Schema:

{"type":"object","$schema":"http://json-schema.org/draft-03/schema#","title":"ApplicationAccountPayload","properties":{"accountId":{"type":"integer","required":false,"title":"accountId"}}}

Example:

{"accountId":1}

HTTP status code 200

Successful response

HTTP status code 400

Bad request

Body

Type: application/json

Example:

{"userMsg":"sample userMsg","moreInfoUrl":"sample moreInfoUrl","errorCode":1,"moreInfo":"sample moreInfo"}

ApplicationsIDEntitlements

/applications/{ID}/entitlements post

post

Update the entitlements for an application

Request
Response

URI Parameters

ID: (integer)
Application ID

Body

Type: application/json

Schema:

{"type":"object","$schema":"http://json-schema.org/draft-03/schema#","title":"ApplicationEntitlements"}

Example:

{"applicationEntitlements": [{"entitlement" : "entitlement1","action" : "A"},{"entitlement" : "entitlement2","action" : "D"}]}

HTTP status code 200

Successful response

HTTP status code 400

Bad request

Body

Type: application/json

Example:

{"userMsg":"sample userMsg","moreInfoUrl":"sample moreInfoUrl","errorCode":1,"moreInfo":"sample moreInfo"}

ApplicationsIDRegenerateprodkey

/applications/{ID}/regenerate-prod-key post

post

Refresh the application token

Request
Response

URI Parameters

ID: (integer)
Application ID

Body

Type: application/json

Schema:

{"type":"object","$schema":"http://json-schema.org/draft-03/schema#","title":"TokenRefreshPayload","properties":{"validity":{"type":"integer","required":false,"title":"validity"}}}

Example:

{"validity":1}

HTTP status code 200

Successful response

Body

Type: application/json

Schema:

{"type":"object","$schema":"http://json-schema.org/draft-03/schema#","title":"LoginResponse","properties":{"sandboxToken":{"type":"string","required":false,"title":"sandboxToken"},"prodToken":{"type":"string","required":false,"title":"prodToken"}}}

Example:

{"sandboxToken":"sample sandboxToken","prodToken":"sample prodToken"}

HTTP status code 400

Bad request

Body

Type: application/json

Example:

{"userMsg":"sample userMsg","moreInfoUrl":"sample moreInfoUrl","errorCode":1,"moreInfo":"sample moreInfo"}

ApplicationsIDResources

/applications/{ID}/resources post

post

Add or remove API resources for a given application

Request
Response

URI Parameters

ID: (integer)
Application ID

Body

Type: application/json

Schema:

{"type":"object","$schema":"http://json-schema.org/draft-03/schema#","title":"ApplicationSubscriptionItem","properties":{"apiId":{"type":"integer","required":false,"title":"apiId"},"action":{"type":"string","required":false,"title":"action"}}}

Example:

{"apiId":1,"action":"sample action"}

HTTP status code 200

Successful response

HTTP status code 400

Bad request

Body

Type: application/json

Example:

{"userMsg":"sample userMsg","moreInfoUrl":"sample moreInfoUrl","errorCode":1,"moreInfo":"sample moreInfo"}

ApplicationsIDUserentitlements

/applications/{ID}/user-entitlements post

post

Update user entitlements for an application

Request
Response

URI Parameters

ID: (integer)
Application ID

Body

Type: application/json

Schema:

{"type":"object","$schema":"http://json-schema.org/draft-03/schema#","title":"ApplicationUserEntitlements"}

Example:

{"userEntitlements": [{"userId" : 123,"entitlement" : "some_resource_group_entitlement","action" : "A"},{"userId" : 124,"entitlement" : "another_entitlement","action" : "A"},{"userId" : 125,"entitlement" : "some_other_entitlement","action" : "D"}]}

HTTP status code 200

Successful response

HTTP status code 400

Bad request

Body

Type: application/json

Example:

{"userMsg":"sample userMsg","moreInfoUrl":"sample moreInfoUrl","errorCode":1,"moreInfo":"sample moreInfo"}

Billingaddresses

When a Billing Address is created using the POST method, the country identification supplied should be in the form of the 3-character ISO 3166 code.

/billing-addresses get post

get

Get the billing addresses for the calling company

post

Create a billing address for the calling company

Get the billing addresses for the calling company

Response

HTTP status code 200

Successful response

Body

Type: application/json

Schema:

{"type":"object","$schema":"http://json-schema.org/draft-03/schema#","title":"BillingAddress","properties":{"id":{"type":"integer","required":false,"title":"id"},"zip":{"type":"string","required":false,"title":"zip"},"state":{"type":"string","required":false,"title":"state"},"addressLine2":{"type":"string","required":false,"title":"addressLine2"},"attention":{"type":"string","required":false,"title":"attention"},"addressLine1":{"type":"string","required":false,"title":"addressLine1"},"country":{"type":"string","required":false,"title":"country"},"city":{"type":"string","required":false,"title":"city"},"addressName":{"type":"string","required":false,"title":"addressName"}}}

Example:

[{"id":1,"zip":"sample zip","state":"sample state","addressLine2":"sample addressLine2","attention":"sample attention","addressLine1":"sample addressLine1","country":"sample country","city":"sample city","addressName":"sample addressName"}]

HTTP status code 400

Bad request

Body

Type: application/json

Example:

{"userMsg":"sample userMsg","moreInfoUrl":"sample moreInfoUrl","errorCode":1,"moreInfo":"sample moreInfo"}

Create a billing address for the calling company

Request
Response

Body

Type: application/json

Schema:

{"type":"object","$schema":"http://json-schema.org/draft-03/schema#","title":"BillingAddress","properties":{"id":{"type":"integer","required":false,"title":"id"},"zip":{"type":"string","required":false,"title":"zip"},"state":{"type":"string","required":false,"title":"state"},"addressLine2":{"type":"string","required":false,"title":"addressLine2"},"attention":{"type":"string","required":false,"title":"attention"},"addressLine1":{"type":"string","required":false,"title":"addressLine1"},"country":{"type":"string","required":false,"title":"country"},"city":{"type":"string","required":false,"title":"city"},"addressName":{"type":"string","required":false,"title":"addressName"}}}

Example:

{"id":1,"zip":"sample zip","state":"sample state","addressLine2":"sample addressLine2","attention":"sample attention","addressLine1":"sample addressLine1","country":"sample country","city":"sample city","addressName":"sample addressName"}

HTTP status code 200

Successful response

HTTP status code 400

Bad request

Body

Type: application/json

Example:

{"userMsg":"sample userMsg","moreInfoUrl":"sample moreInfoUrl","errorCode":1,"moreInfo":"sample moreInfo"}

BillingaddressesID

When a Billing Address is updated using the POST method, the country identification supplied should be in the form of the 3-character ISO 3166 code.

/billing-addresses/{ID} get post

get

Get a specific billing address

post

Update a billing address

Get a specific billing address

Request
Response

URI Parameters

ID: (integer)
Billing Address ID

HTTP status code 200

Successful response

Body

Type: application/json

Schema:

{"type":"object","$schema":"http://json-schema.org/draft-03/schema#","title":"BillingAddress","properties":{"id":{"type":"integer","required":false,"title":"id"},"zip":{"type":"string","required":false,"title":"zip"},"state":{"type":"string","required":false,"title":"state"},"addressLine2":{"type":"string","required":false,"title":"addressLine2"},"attention":{"type":"string","required":false,"title":"attention"},"addressLine1":{"type":"string","required":false,"title":"addressLine1"},"country":{"type":"string","required":false,"title":"country"},"city":{"type":"string","required":false,"title":"city"},"addressName":{"type":"string","required":false,"title":"addressName"}}}

Example:

{"id":1,"zip":"sample zip","state":"sample state","addressLine2":"sample addressLine2","attention":"sample attention","addressLine1":"sample addressLine1","country":"sample country","city":"sample city","addressName":"sample addressName"}

HTTP status code 400

Bad request

Body

Type: application/json

Example:

{"userMsg":"sample userMsg","moreInfoUrl":"sample moreInfoUrl","errorCode":1,"moreInfo":"sample moreInfo"}

Update a billing address

Request
Response

URI Parameters

ID: (integer)
Billing Address ID

Body

Type: application/json

Schema:

{"type":"object","$schema":"http://json-schema.org/draft-03/schema#","title":"BillingAddress","properties":{"id":{"type":"integer","required":false,"title":"id"},"zip":{"type":"string","required":false,"title":"zip"},"state":{"type":"string","required":false,"title":"state"},"addressLine2":{"type":"string","required":false,"title":"addressLine2"},"attention":{"type":"string","required":false,"title":"attention"},"addressLine1":{"type":"string","required":false,"title":"addressLine1"},"country":{"type":"string","required":false,"title":"country"},"city":{"type":"string","required":false,"title":"city"},"addressName":{"type":"string","required":false,"title":"addressName"}}}

Example:

{"id":1,"zip":"sample zip","state":"sample state","addressLine2":"sample addressLine2","attention":"sample attention","addressLine1":"sample addressLine1","country":"sample country","city":"sample city","addressName":"sample addressName"}

HTTP status code 200

Successful reposne

HTTP status code 400

Bad request

Body

Type: application/json

Example:

{"userMsg":"sample userMsg","moreInfoUrl":"sample moreInfoUrl","errorCode":1,"moreInfo":"sample moreInfo"}

Clienttoken

/client-token get

get

Obtain the client token for the caller

Response

HTTP status code 200

Successful response

Body

Type: application/json

Schema:

{"type":"object","$schema":"http://json-schema.org/draft-03/schema#","title":"PaymentClientToken","properties":{"clientToken":{"type":"string","required":false,"title":"clientToken"}}}

Example:

{"clientToken":"sample clientToken"}

HTTP status code 400

Bad request

Body

Type: application/json

Example:

{"userMsg":"sample userMsg","errorCode":1,"moreInfoUrl":"sample moreInfoUrl","moreInfo":"sample moreInfo"}

Companies

When you log in to the portal for the first time, it is recommended that you provide a name for your company. The name of your company can be a working name within the Syniverse Developer Community or a legal company name. (If the company name is not a legal company name, postpay accounts cannot be created as a funding mechanism)

All accounts, users and applications are tied to this company.

Merging your company to another company in the Syniverse Developer Community.

When merging two companies, please note the following changes:

User entitlements will be limited.
Account and application access will be limited.
Postpay accounts will be placed into pending state.

The company taking over retains all of its entitlements and takes over all assets from the merged company. The new parent company administrators will need to re-entitle previous users.

/companies post

post

Create a company

Request
Response

Body

Type: application/json

Schema:

{"type":"object","$schema":"http://json-schema.org/draft-03/schema#","title":"Company","properties":{"companyName":{"type":"string","required":false,"title":"companyName"}}}

Example:

{"companyName":"sample companyName"}

HTTP status code 200

Successful reponse

HTTP status code 400

Bad request

Body

Type: application/json

Example:

{"userMsg":"sample userMsg","moreInfoUrl":"sample moreInfoUrl","errorCode":1,"moreInfo":"sample moreInfo"}

CompaniesInvitecode

/companies/invite-code post

post

Get an invite code for the calling company

Response

HTTP status code 200

Successful response

Body

Type: application/json

Schema:

{"type":"object","$schema":"http://json-schema.org/draft-03/schema#","title":"InviteCode","properties":{"code":{"type":"string","required":false,"title":"code"}}}

Example:

{"code":"sample code"}

HTTP status code 400

Bad request

Body

Type: application/json

Example:

{"userMsg":"sample userMsg","moreInfoUrl":"sample moreInfoUrl","errorCode":1,"moreInfo":"sample moreInfo"}

CompaniesTasks

/companies/tasks get

get

Get task details for this company

Response

HTTP status code 200

Successful response

Body

Type: application/json

Schema:

{"type":"object","$schema":"http://json-schema.org/draft-03/schema#","title":"TaskDetails","properties":{"message":{"type":"string","required":false,"title":"message"},"id":{"type":"integer","required":false,"title":"id"},"status":{"type":"string","required":false,"title":"status"},"email":{"type":"string","required":false,"title":"email"},"userId":{"type":"string","required":false,"title":"userId"},"name":{"type":"string","required":false,"title":"name"},"inviteCode":{"type":"string","required":false,"title":"inviteCode"},"requestType":{"type":"string","required":false,"title":"requestType"}}}

Example:

[{"message":"sample message","id":1,"status":"sample status","email":"sample email","userId":"sample userId","name":"sample name","inviteCode":"sample inviteCode","requestType":"sample requestType"}]

HTTP status code 400

Bad request

Body

Type: application/json

Example:

{"userMsg":"sample userMsg","moreInfoUrl":"sample moreInfoUrl","errorCode":1,"moreInfo":"sample moreInfo"}

CompaniesName

/companies/name post

post

Change the company name

Response

HTTP status code 200

Successful response

Body

Type: application/json

Schema:

{"type":"object","$schema":"http://json-schema.org/draft-03/schema#","title":"Company","properties":{"companyName":{"type":"string","required":false,"title":"companyName"}}}

Example:

{"name":"Syniverse Technologies"}

HTTP status code 400

Bad request

Body

Type: application/json

Example:

{"userMsg":"sample userMsg","moreInfoUrl":"sample moreInfoUrl","errorCode":1,"moreInfo":"sample moreInfo"}

Entitlements

/entitlements get

get

Get entitlements for this user

Response

HTTP status code 200

Success

Body

Type: application/json

Schema:

string[]

Example:

["entitlement1","entitlement2","entitlement3"]

HTTP status code 400

Bad request

Body

Type: application/json

Example:

{"userMsg":"sample userMsg","moreInfoUrl":"sample moreInfoUrl","errorCode":1,"moreInfo":"sample moreInfo"}

/login post

post

Request
Response

Body

Type: application/json

Schema:

{"type":"object","$schema":"http://json-schema.org/draft-03/schema#","title":"Login","properties":{"username":{"type":"string","required":false,"title":"username"},"password":{"type":"string","required":false,"title":"password"}}}

Example:

{"username":"sample username","password":"sample password"}

HTTP status code 200

Successful response

HTTP status code 401

User is unauthorized

Logout

/logout post

post

Payments

/payments get post

get

Get payment methods for a company

post

Create a payment method

Get payment methods for a company

Response

HTTP status code 200

Successful response

Body

Type: application/json

Schema:

{"type":"object","$schema":"http://json-schema.org/draft-03/schema#","title":"PaymentMethod","properties":{"validationKey1":{"type":"integer","required":false,"title":"validationKey1"},"token":{"type":"string","required":false,"title":"token"},"status":{"type":"string","required":false,"title":"status"},"validationKey2":{"type":"integer","required":false,"title":"validationKey2"},"description":{"type":"string","required":false,"title":"description"},"company":{"type":"string","required":false,"title":"company"},"name":{"type":"string","required":false,"title":"name"},"validationStart":{"type":"string","required":false,"title":"validationStart"},"provider":{"type":"string","required":false,"title":"provider"},"paymentMethodId":{"type":"integer","required":false,"title":"paymentMethodId"},"type":{"type":"string","required":false,"title":"type"},"expiry":{"type":"string","required":false,"title":"expiry"}}}

Example:

[{"validationKey1":1,"token":"sample token","status":"sample status","validationKey2":1,"description":"sample description","company":"sample company","name":"sample name","validationStart":null,"provider":"sample provider","paymentMethodId":1,"type":"sample type","expiry":null}]

HTTP status code 400

Bad request

Body

Type: application/json

Example:

{"userMsg":"sample userMsg","moreInfoUrl":"sample moreInfoUrl","errorCode":1,"moreInfo":"sample moreInfo"}

Create a payment method

Request
Response

Body

Type: application/json

Schema:

{"type":"object","$schema":"http://json-schema.org/draft-03/schema#","title":"PaymentMethodPayload","properties":{"nonce":{"type":"string","required":false,"title":"nonce"},"name":{"type":"string","required":false,"title":"name"}}}

Example:

{"nonce":"sample nonce","name":"sample name"}

HTTP status code 200

Successful response

HTTP status code 400

Bad request

Body

Type: application/json

Example:

{"userMsg":"sample userMsg","moreInfoUrl":"sample moreInfoUrl","errorCode":1,"moreInfo":"sample moreInfo"}

PaymentsID

/payments/{ID} get delete

get

Get a specific payment method

delete

Delete a payment method

Get a specific payment method

Request
Response

URI Parameters

ID: (integer)
Payment Method ID

HTTP status code 200

Successful response

Body

Type: application/json

Schema:

{"type":"object","$schema":"http://json-schema.org/draft-03/schema#","title":"PaymentMethod","properties":{"validationKey1":{"type":"integer","required":false,"title":"validationKey1"},"token":{"type":"string","required":false,"title":"token"},"status":{"type":"string","required":false,"title":"status"},"validationKey2":{"type":"integer","required":false,"title":"validationKey2"},"description":{"type":"string","required":false,"title":"description"},"company":{"type":"string","required":false,"title":"company"},"name":{"type":"string","required":false,"title":"name"},"validationStart":{"type":"string","required":false,"title":"validationStart"},"provider":{"type":"string","required":false,"title":"provider"},"paymentMethodId":{"type":"integer","required":false,"title":"paymentMethodId"},"type":{"type":"string","required":false,"title":"type"},"expiry":{"type":"string","required":false,"title":"expiry"}}}

Example:

{"validationKey1":1,"token":"sample token","status":"sample status","validationKey2":1,"description":"sample description","company":"sample company","name":"sample name","validationStart":null,"provider":"sample provider","paymentMethodId":1,"type":"sample type","expiry":null}

HTTP status code 400

Bad request

Body

Type: application/json

Example:

{"userMsg":"sample userMsg","moreInfoUrl":"sample moreInfoUrl","errorCode":1,"moreInfo":"sample moreInfo"}

Delete a payment method

Request
Response

URI Parameters

ID: (integer)
Payment Method ID

HTTP status code 200

Successful response

HTTP status code 400

Bad request

Body

Type: application/json

Example:

{"userMsg":"sample userMsg","moreInfoUrl":"sample moreInfoUrl","errorCode":1,"moreInfo":"sample moreInfo"}

PricingID

/pricing/{ID} get

get

Get the pricelist for service offering

Request
Response

URI Parameters

ID: required (integer)
Service Offering ID

Query Parameters

filter: (string - repeat: true)
String value specifying rate filter to apply (e.g. filter=FILTER_NAME:FILTER_VALUE)

HTTP status code 200

Successful Response

Body

Type: application/json

Schema:

string[]

Example:

[{"rate": "0.02","event_name":"Dedicated MMS Short Code MT Fee","x_dimension_name": "To","x_dimension_value": "United States","y_dimension_name": "From","y_dimension_value": "Any"}]

HTTP status code 500

Internal Server Error

Body

Type: application/json

Example:

{"userMsg":"sample userMsg","moreInfoUrl":"sample moreInfoUrl","errorCode":1,"moreInfo":"sample moreInfo"}

PricingID Filters

/pricing/{ID}/filters get

get

Get the filters and allowable values available for use when obtaining the pricelist for a service offering

Request
Response

URI Parameters

ID: required (integer)
Service Offering ID

HTTP status code 200

Successful Response

Body

Type: application/json

Schema:

string[]

Example:

{ "filters":[ {"name": <STRING>, "values": [ <STRING 1> ...<String N>] },  ...  ] }

HTTP status code 500

Internal Server Error

Body

Type: application/json

Example:

{"userMsg":"sample userMsg","moreInfoUrl":"sample moreInfoUrl","errorCode":1,"moreInfo":"sample moreInfo"}

ResourcegroupsIDEntitlements

/resource-groups/{ID}/entitlements get

get

Request
Response

URI Parameters

ID: (integer)
Resource Group ID

HTTP status code 200

Successful Response

Body

Type: application/json

Schema:

string[]

Example:

["entitlement1","entitlement2","entitlement3"]

HTTP status code 400

Bad request

Body

Type: application/json

Example:

{"userMsg":"sample userMsg","moreInfoUrl":"sample moreInfoUrl","errorCode":1,"moreInfo":"sample moreInfo"}

Serviceofferings

Powering the Syniverse Developer Community are service offerings, which enable actions from your application.

Service offerings contain all the APIs you will call and utilize to communicate, request information or send messages to your customers. To get you started, we have provided three simple templates to test with the Syniverse Messaging Offering. The templates include:

Two-Factor Authentication, which validates and authenticates users.
Password Reset, which securely resets user passwords in your applications.
Event messages, which are messages that are sent to users based on an action, such as sending users a text message that says their order is being delivered to them.

Once you are done with testing with the templates, you can start sending any message types to your users.

Some countries or regions will limit your ability to send messages from certain numbers. For example, in the U.S., messages that are sent by application to person (A2P) messaging using long codes are often blocked and stop your service functionality.

/service-offerings get

get

Get the service offerings for the calling company

Response

HTTP status code 200

Successful response

Body

Type: application/json

Schema:

{"type":"object","$schema":"http://json-schema.org/draft-03/schema#","title":"ServiceOffering"}

Example:

[{"id":1,"resources":[],"subscriptions":[],"description":"sample description","name":"sample name","termsAndConditions":"sample termsAndConditions","pricings":[]}]

HTTP status code 400

Bad request

Body

Type: application/json

Example:

{"userMsg":"sample userMsg","moreInfoUrl":"sample moreInfoUrl","errorCode":1,"moreInfo":"sample moreInfo"}

ServiceofferingsID

/service-offerings/{ID} get

get

Get a specific service offering

Request
Response

URI Parameters

ID: (integer)
Service Offering ID

HTTP status code 200

Successful response

Body

Type: application/json

Schema:

{"type":"object","$schema":"http://json-schema.org/draft-03/schema#","title":"ServiceOffering"}

Example:

{"id":1,"resources":[],"subscriptions":[],"description":"sample description","name":"sample name","termsAndConditions":"sample termsAndConditions","pricings":[]}

HTTP status code 400

Bad request

Body

Type: application/json

Example:

{"userMsg":"sample userMsg","moreInfoUrl":"sample moreInfoUrl","errorCode":1,"moreInfo":"sample moreInfo"}

ServiceofferingsIDAvailableaccounts

/service-offerings/{ID}/available-accounts get

get

Get available accounts for a service offering

Request
Response

URI Parameters

ID: (integer)
Service offering ID

HTTP status code 200

Successful response

Body

Type: application/json

Schema:

{"type":"object","$schema":"http://json-schema.org/draft-03/schema#","title":"ServiceOfferingAccount","properties":{"id":{"type":"integer","required":false,"title":"id"},"accountName":{"type":"string","required":false,"title":"accountName"},"accountId":{"type":"integer","required":false,"title":"accountId"},"validFrom":{"type":"string","required":false,"title":"validFrom"},"accountRestricted":{"type":"boolean","required":false,"title":"accountRestricted","default":"false"}}}

Example:

[{"id":1,"accountName":"sample accountName","accountId":1,"validFrom":"sample validFrom","accountRestricted":false}]

HTTP status code 400

Bad request

Body

Type: application/json

Example:

{"userMsg":"sample userMsg","moreInfoUrl":"sample moreInfoUrl","errorCode":1,"moreInfo":"sample moreInfo"}

Subscriptions

/subscriptions post

post

Enter a subscription for the current user

Request
Response

Body

Type: application/json

Schema:

{"type":"object","$schema":"http://json-schema.org/draft-03/schema#","title":"Subscription","properties":{"offeringId":{"type":"string","required":false,"title":"offeringId"},"accountId":{"type":"integer","required":false,"title":"accountId"},"acceptTC":{"type":"boolean","required":false,"title":"acceptTC","default":"false"}}}

Example:

{"offeringId":"sample offeringId","accountId":1,"acceptTC":false}

HTTP status code 200

Successful response

HTTP status code 400

Bad request

Body

Type: application/json

Example:

{"userMsg":"sample userMsg","moreInfoUrl":"sample moreInfoUrl","errorCode":1,"moreInfo":"sample moreInfo"}

SubscriptionsIDUnsubscribe

/subscriptions/{ID}/unsubscribe post

post

Unsubscribe the current user

Request
Response

URI Parameters

ID: (integer)
Subscription ID

HTTP status code 200

Successful response

HTTP status code 400

Bad request

Body

Type: application/json

Example:

{"userMsg":"sample userMsg","moreInfoUrl":"sample moreInfoUrl","errorCode":1,"moreInfo":"sample moreInfo"}

TasksAcceptID

Tasks are items that require actions from entitled users, such as users who want to join your company, request use of a restricted account for their application, or request elevated entitlements for the Syniverse Developer portal.

/tasks/accept/{ID} post

post

Accept a task

Request
Response

URI Parameters

ID: (integer)
Task ID

HTTP status code 200

Successful response

HTTP status code 400

Bad request

Body

Type: application/json

Example:

{"userMsg":"sample userMsg","moreInfoUrl":"sample moreInfoUrl","errorCode":1,"moreInfo":"sample moreInfo"}

TasksCancelID

/tasks/cancel/{ID} post

post

Cancel a task

Request
Response

URI Parameters

ID: (integer)
Task ID

HTTP status code 200

Successful response

HTTP status code 400

Bad request

Body

Type: application/json

Example:

{"userMsg":"sample userMsg","moreInfoUrl":"sample moreInfoUrl","errorCode":1,"moreInfo":"sample moreInfo"}

TasksRejectID

/tasks/reject/{ID} post

post

Reject a task

Request
Response

URI Parameters

ID: (integer)
Task ID

HTTP status code 200

Successful response

HTTP status code 400

Bad request

Body

Type: application/json

Example:

{"userMsg":"sample userMsg","moreInfoUrl":"sample moreInfoUrl","errorCode":1,"moreInfo":"sample moreInfo"}

Users

User management within the portal is very simple. As the main user of a company, you are responsible for the management of other users within your company environment.

To provide user access under your company, you will need to create an invite code required for all users to sign up in your company. The invite code will generate a request to join your company, and as the company administrator, you will need to accept invitation requests and verify users. We recommend giving these users limited entitlements to help them to complete their tasks but entitlements that won’t put your company at risk.

Company administrators can set different levels of entitlements for their users to manage what they can do within the Developer Community. Entitlement actions include the capability to create new accounts, edit or modify payment methods, edit or delete applications, refresh application authentication keys, accept new users into a company, merge company, and modify user entitlements.

We recommend that company administrators do not allow unlimited entitlements to all users.

/users get

get

Get users associated with the current company

Response

HTTP status code 200

Successful response

Body

Type: application/json

Schema:

{"type":"object","$schema":"http://json-schema.org/draft-03/schema#","title":"User"}

Example:

[{"id":1,"lastName":"sample lastName","email":"sample email","roles":["sample roles"],"inviteCode":"sample inviteCode","joinId":"sample joinId","companyName":"sample companyName","firstName":"sample firstName"}]

HTTP status code 400

Bad request

Body

Type: application/json

Example:

{"userMsg":"sample userMsg","moreInfoUrl":"sample moreInfoUrl","errorCode":1,"moreInfo":"sample moreInfo"}

UsersMe

/users/me get

get

Get the current user

Response

HTTP status code 200

Successful response

Body

Type: application/json

Schema:

{"type":"object","$schema":"http://json-schema.org/draft-03/schema#","title":"User"}

Example:

{"id":1,"lastName":"sample lastName","email":"sample email","roles":["sample roles"],"inviteCode":"sample inviteCode","joinId":"sample joinId","companyName":"sample companyName","firstName":"sample firstName"}

HTTP status code 400

Bad request

Body

Type: application/json

Example:

{"userMsg":"sample userMsg","moreInfoUrl":"sample moreInfoUrl","errorCode":1,"moreInfo":"sample moreInfo"}

UsersMeJoin

/users/me/join post

post

This user joins a company

Request
Response

Body

Type: application/json

Schema:

{"type":"object","$schema":"http://json-schema.org/draft-03/schema#","title":"JoinCompanyTask","properties":{"inviteCode":{"type":"string","required":false,"title":"inviteCode"}}}

Example:

{"inviteCode":"sample inviteCode"}

HTTP status code 200

Successful response

HTTP status code 400

Bad request

Body

Type: application/json

Example:

{"userMsg":"sample userMsg","moreInfoUrl":"sample moreInfoUrl","errorCode":1,"moreInfo":"sample moreInfo"}

UsersMeLeave

/users/me/leave post

post

This user leaves current company

Response

HTTP status code 200

Successful response

HTTP status code 400

Bad request

Body

Type: application/json

Example:

{"userMsg":"sample userMsg","moreInfoUrl":"sample moreInfoUrl","errorCode":1,"moreInfo":"sample moreInfo"}

UsersMeTasks

/users/me/tasks get

get

Get tasks associated with the current user

Response

HTTP status code 200

Successful response

Body

Type: application/json

Schema:

{"type":"object","$schema":"http://json-schema.org/draft-03/schema#","title":"TaskDetails","properties":{"message":{"type":"string","required":false,"title":"message"},"id":{"type":"integer","required":false,"title":"id"},"status":{"type":"string","required":false,"title":"status"},"email":{"type":"string","required":false,"title":"email"},"userId":{"type":"string","required":false,"title":"userId"},"name":{"type":"string","required":false,"title":"name"},"inviteCode":{"type":"string","required":false,"title":"inviteCode"},"requestType":{"type":"string","required":false,"title":"requestType"}}}

Example:

[{"message":"sample message","id":1,"status":"sample status","email":"sample email","userId":"sample userId","name":"sample name","inviteCode":"sample inviteCode","requestType":"sample requestType"}]

HTTP status code 400

Bad request

Body

Type: application/json

Example:

{"userMsg":"sample userMsg","moreInfoUrl":"sample moreInfoUrl","errorCode":1,"moreInfo":"sample moreInfo"}

SDCEntitlements

/accounts/sdc-entitlements get

get

Get entitlements for SDC

Response

HTTP status code 200

Success

Body

Type: application/json

Schema:

string[]

Example:

["entitlement1","entitlement2","entitlement3"]

HTTP status code 400

Bad request

Body

Type: application/json

Example:

{"userMsg":"sample userMsg","moreInfoUrl":"sample moreInfoUrl","errorCode":1,"moreInfo":"sample moreInfo"}

TransDetails

/reports/app/api/transdetails get

get

Retrieve Transaction details at API level for given application,date

Request
Response

Query Parameters

appId: required (integer)
ID of referenced application
apiId: required (integer)
ID of referenced api
accountId: required (integer)
ID of referenced account
date: required (string)
Transaction date in format YYYY-MM-DD

HTTP status code 200

Successful response

Body

Type: application/json

Schema:

{"type":"object","$schema":"http://json-schema.org/draft-03/schema#","title":"ApiTransReport"}

Example:

{"apiId" : 110,"apiName" : "Messaging","transactions" : [{"statementId" : "2032","txnDateTime" : "2016/02/26 12:00:43 AM","externalReference" : " ","xDimNm" : "To","xDimValue" : "310","yDimNm" : " ","yDimValue" : " ","chargeableUnits" : "1","taxRate" : "6%","tax" : "0.0003","txnValue" : "0.0053","taxName" : "Florida Sales Tax","currencyCode" : "USD","bifBillingId" : "10687","transactionType" : "SERVICE","unitRate" : "0.005"},{"statementId" : "2032","txnDateTime" : "2016/02/26 12:00:43 AM","externalReference" : " ","xDimNm" : "To","xDimValue" : "310","yDimNm" : " ","yDimValue" : " ","chargeableUnits" : "1","taxRate" : "6%","tax" : "0.0003","txnValue" : "0.0053","taxName" : "Florida Sales Tax","currencyCode" : "USD","bifBillingId" : "10687","transactionType" : "SERVICE","unitRate" : "0.005"}]}

HTTP status code 400

Bad request

Body

Type: application/json

Example:

{"userMsg":"sample userMsg","moreInfoUrl":"sample moreInfoUrl","errorCode":1,"moreInfo":"sample moreInfo"}

Syniverse Developer Community API documentation version 1.0.0

Accounts

get /accounts

HTTP status code 200

Body

HTTP status code 400

Body

post /accounts

Body

HTTP status code 200

HTTP status code 400

Body

AccountsID

get /accounts/{ID}

URI Parameters

HTTP status code 200

Body

HTTP status code 400

Body

delete /accounts/{ID}

URI Parameters

HTTP status code 200

HTTP status code 400

Body

AccountsIDBillingaddress

post /accounts/{ID}/billing-address

URI Parameters

Body

HTTP status code 200

HTTP status code 400

Body

AccountsIDEntitlements

get /accounts/{ID}/entitlements

URI Parameters

HTTP status code 200

Body

HTTP status code 400

Body

AccountsIDRename

post /accounts/{ID}/rename

URI Parameters

Body

HTTP status code 200

HTTP status code 400

Body

AccountsIDResources

get /accounts/{ID}/resources

URI Parameters

HTTP status code 200

Body

HTTP status code 400

Body

AccountsIDRestrict

post /accounts/{ID}/restrict

URI Parameters

HTTP status code 200

HTTP status code 400

Body

AccountsIDTopup

post /accounts/{ID}/top-up

URI Parameters

Body

HTTP status code 200

HTTP status code 400

Body

AccountsIDUnrestrict

post /accounts/{ID}/unrestrict

URI Parameters

HTTP status code 200

HTTP status code 400

Body

Applications

get /applications

HTTP status code 200

Body

HTTP status code 400

Body

post /applications

Body

HTTP status code 200