# Sinch Port-in numbers API

**Canonical:** https://apis.io/apis/sinch/sinch-port-in-numbers-api/  
**Provider:** Sinch — https://apis.io/providers/sinch/  
**Base URL:** https://us.conversation.api.sinch.com  
**Documentation:** https://developers.sinch.com/docs/conversation/api-reference/conversation

Sinch Port-in numbers API is one of 101 APIs that [Sinch](https://apis.io/providers/sinch/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification. This API exposes 73 JSON Schema definitions. Tagged areas include Port-in numbers. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, an AsyncAPI specification, and 73 JSON Schemas.

You can create orders, check portability, and more. When you port in phone numbers to Sinch you need to make sure the numbers are portable, you can use the portability check to make sure the numbers are portable before creating an order. If a number is not portable the whole order will fail. When porting a number to Sinch you can either use the dashboard or the API, the API is recommended for larger orders and for automation. **Note:** For port orders of over 500 numbers, please contact the [support team](https://support.sinch.com). The recommended way to port numbers to Sinch is to schedule the port, this means that you create an order and specify a desired port date and time, If you have more advanced needs like on-demand activation, you can read more about that in the [advanced porting section](https://developers.sinch.com/docs/numbers/api-reference/porting/advanced-porting/). ### Porting orders In general you work with porting orders, a porting order is the resource that keeps the number(s) status and progress in one place. Before creating port order you should check the portability of the numbers you want to port in, if a number is not portable the order will fail. ```json POST /portabilityChecks { "phoneNumbers": ["+12345678901"] } ``` If the number is portable you can create an order like this: ```json POST v1/projects/{projectId}/orders/portIns { "desiredPortSchedule": { "desiredPortDate": "2024-09-25", }, "phoneNumbers": [ { "phoneNumber": "+12345678901", "voiceConfiguration": { "type": "EST", "trunkId": "123456" }, "portOutInfo": { "existingPortOutPin": "1234" }, "endUser": { "name": "John Doe", "streetName": "Main St", "streetNum": "123", "city": "Anytown", "state": "NY", "zipCode": "12345" }, } ] } ``` #### Lifetime of a port order If everything is correct, the order run thru is life cycle and keep you updated on changes but hopefully nothing will change and the number will be ported in on the desired port date. If more information is needed from you, it will be communicated to you via the order notes and error statuses on the individual numbers. And you reply with a note or update your order with required information. It's not uncommon for a port order to be a few days or weeks in the making, so don't worry if you don't receive an update right away. ### Port-In phone numbers When you port in phone numbers to Sinch you need to make sure the numbers are portable, you can use the portability check to make sure the numbers are portable before creating an order.

## Operations (9)

| Method | Path | Summary |
|---|---|---|
| POST | `/portabilityChecks` | Porting availability |
| POST | `/orders/portIns` | Create port-in order |
| GET | `/orders/portIns` | List port-in orders |
| GET | `/orders/portIns/{orderId}` | Get order Detail |
| DELETE | `/orders/portIns/{orderId}` | Cancel Pending Order |
| PUT | `/orders/portIns/{orderId}` | Update port-in order |
| POST | `/orders/portIns/{orderId}/notes` | Add Order Note |
| POST | `/orders/portIns/{orderId}/documents` | Add Order Document |
| GET | `/orders/{orderId}/documents/{documentId}` | Get document content |

## Machine-readable artifacts (107)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/sinch/refs/heads/main/openapi/sinch-port-in-numbers-api-openapi.yml
- **Documentation** — https://developers.sinch.com/docs/conversation
- **APIReference** — https://developers.sinch.com/docs/conversation/api-reference/template
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/sinch/refs/heads/main/json-schema/sinch-v2-template-schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/sinch/refs/heads/main/json-schema/sinch-v2-list-translations-response-schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/sinch/refs/heads/main/json-schema/sinch-v2-list-templates-response-schema.json
- **Documentation** — https://developers.sinch.com/docs/est
- **APIReference** — https://developers.sinch.com/docs/est/api-reference/est
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/sinch/refs/heads/main/json-schema/sinch-call-schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/sinch/refs/heads/main/json-schema/sinch-sip-trunk-schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/sinch/refs/heads/main/json-schema/sinch-sip-endpoint-schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/sinch/refs/heads/main/json-schema/sinch-ip-range-schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/sinch/refs/heads/main/json-schema/sinch-access-control-list-schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/sinch/refs/heads/main/json-schema/sinch-number-schema.json
- **Documentation** — https://developers.sinch.com/docs/fax
- **APIReference** — https://developers.sinch.com/docs/fax/api-reference/fax
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/sinch/refs/heads/main/json-schema/sinch-fax-schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/sinch/refs/heads/main/json-schema/sinch-service-schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/sinch/refs/heads/main/json-schema/sinch-template-by-name-response-schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/sinch/refs/heads/main/json-schema/sinch-update-template-request-schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/sinch/refs/heads/main/json-schema/sinch-service-phone-number-schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/sinch/refs/heads/main/json-schema/sinch-cover-page-schema.json
- **Documentation** — https://developers.sinch.com/docs/number-lookup-api-v2
- **APIReference** — https://developers.sinch.com/docs/number-lookup-api-v2/api-reference/number-lookup-v2
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/sinch/refs/heads/main/json-schema/sinch-number-lookup-response-schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/sinch/refs/heads/main/json-schema/sinch-number-lookup-request-schema.json
- **Documentation** — https://developers.sinch.com/docs/numbers
- **APIReference** — https://developers.sinch.com/docs/numbers/api-reference/imported-hosting
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/sinch/refs/heads/main/json-schema/sinch-hosting-order-schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/sinch/refs/heads/main/json-schema/sinch-qualified-number-schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/sinch/refs/heads/main/json-schema/sinch-text-enable-numbers-request-schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/sinch/refs/heads/main/json-schema/sinch-hosting-order-number-schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/sinch/refs/heads/main/json-schema/sinch-imported-number-schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/sinch/refs/heads/main/json-schema/sinch-list-imported-numbers-response-schema.json
- **APIReference** — https://developers.sinch.com/docs/numbers/api-reference/numbers
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/sinch/refs/heads/main/json-schema/sinch-active-number-response-schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/sinch/refs/heads/main/json-schema/sinch-rent-any-number-request-schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/sinch/refs/heads/main/json-schema/sinch-validate-address-response-schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/sinch/refs/heads/main/json-schema/sinch-number-order-schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/sinch/refs/heads/main/json-schema/sinch-create-number-order-request-schema.json
- …and 67 more, listed in full on the page.

## Other Sinch APIs (12)

- [Sinch Conversation API](https://apis.io/apis/sinch/sinch-conversation-api/)
- [Sinch Voice API](https://apis.io/apis/sinch/sinch-voice-api/)
- [Sinch Brands API](https://apis.io/apis/sinch/sinch-brands-api/)
- [Sinch MMS API](https://apis.io/apis/sinch/sinch-mms-api/)
- [Sinch Batches API](https://apis.io/apis/sinch/sinch-batches-api/)
- [Sinch Delivery Reports API](https://apis.io/apis/sinch/sinch-delivery-reports-api/)
- [Sinch Inbounds API](https://apis.io/apis/sinch/sinch-inbounds-api/)
- [Sinch Groups API](https://apis.io/apis/sinch/sinch-groups-api/)
- [Sinch 10DLC Brand Registration API](https://apis.io/apis/sinch/sinch-10dlc-brand-registration-api/)
- [Sinch 10DLC Campaign Registration API](https://apis.io/apis/sinch/sinch-10dlc-campaign-registration-api/)
- [Sinch Access Control List API](https://apis.io/apis/sinch/sinch-access-control-list-api/)
- [Sinch Access Control Lists API](https://apis.io/apis/sinch/sinch-access-control-lists-api/)

## Tags

Port-in numbers

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/sinch/sinch-port-in-numbers-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/sinch/.