How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

BICS Porting API

The porting API from BICS — 4 operation(s) for porting.

BICS Porting API is one of 24 APIs that BICS publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Porting. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 7 operations across 4 paths, and defines 23 schemas. It is described by OpenAPI 3.2.0, at version v1.

Requests are made against 2 base URLs: https://api.bics.com/mynumbers-porting/v1, https://sandbox.api.bics.com/mynumbers-porting/v1.

7 operations 4 paths 23 schemas 1 DELETE3 GET1 PATCH2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
v1
Base URL
https://api.bics.com/sms/v3
Resource Areas
1

Paths & Operations 7

Across 4 paths, the API surfaces 7 operations — 1 DELETE, 3 GET, 1 PATCH, 2 POST. Each is listed below with its method, path, parameters, and response codes.

Porting 7
GET
/portings/{portingRequestId}/documents
This method allows you to get your documents allowed for porting request
getPortingRequestDocuments 1 param → 200400404
POST
/portings/{portingRequestId}/documents
This method allows you to add documents to the porting request
UpdatePortingRequestDocuments 1 param body → 400204
GET
/portings
This method allows you to get a list of your porting requests
getPortingRequests 5 params → 200400
POST
/portings
This method allows you to create porting request
CreatePortingRequest body → 200400
PATCH
/portings/{portingRequestId}/addresses
This method allows you to update End User Address and Porting Address in a…
UpdatePortingRequestAddresses 1 param body → 400204
GET
/portings/{portingRequestId}
This method allows you to get your porting request
getPortingRequestById 1 param → 200400404
DELETE
/portings/{portingRequestId}
This method allows you to cancel porting request
cancelPortingRequest 2 params → 200400404

Schemas 23

The contract defines 23 schemas that model the data the API accepts and returns. The most detailed are portingRequestBase (13 properties), createPortingRequest (10 properties), Document (7 properties), customerRouting (5 properties). Each schema is shown below with its type and property counts.

numberRangeOrigin
object
3 properties
addresses
object
2 properties
portingRequest
object
portingRequestDetails
object
createPortingRequest
object
10 properties
error
object
3 properties
crnType
string
The translation rule for the customer routing number that you want to apply to the number. prefix - To prefix the access number with the specified crnValue. su…
detailedAddresses
object
2 properties
createPortingResponse
object
1 property
addressDocumentStatus
string
Validation status: "Uploaded": The file is in process of being uploaded, checked by our virus scanners and attached to your address. "Rejected": The file is re…
accessType
string
Access type of the calling party. You can apply a different routing per access type. The possible values are fix: Fix line mob: Mobile line pay: Payphone line…
numberRange
object
detailedPortingAddress
object
2 properties
Document
object
7 properties
detailedEndUserAddress
object
2 properties
addPortingRequestDocumentsParams
array
portingRequestBase
object
13 properties
documentType
object
Type of document.
2 properties
document
object
1 property
updatePortingRequestAddressesParams
object
1 property
endUserAddress
object
1 property
customerRouting
object
This parameter allows you to specify routing information for the numbers you port. You can differentiate calls based on access type/access network by defining…
5 properties 1 required
portingAddress
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

bics-network-porting-api-openapi.yml Raw ↑

Other APIs BICS publishes across the network.

BICS Number Verification API
BICS Fraud Prevention and Reachability API
BICS Address Management API
BICS CDR API
BICS Connections Management API
BICS Conversions API
BICS Conversionsinfos API
BICS Disconnection Services API
BICS Document Management API
BICS Emergency Services API
BICS Inbound API
BICS Interconnects List API
Where this information came from

This is an independent, third-party profile of BICS Porting API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.