API
Skip to main content

Create entity and associate it with the integration

information
This feature is only available for certain types of integration.
This feature allows you to create an entity in PayPay and associate it with the integration making the request. This way, the same authentication data can be used, and only the header PayPay-ClientId (Entity TIN) needs to be changed to that of the associated entity to start operating within the corresponding entity.

warning
Creating the entity through this feature will follow all necessary regulatory compliance processes.
POST /entities
{
    "clientId": "123456789",
    "name": "Entidade Teste Lda",
    "phoneNumber": "707451451",
    "address": "Estrada Regional 104 ",
    "postCode": "9000-025",
    "locality": "Funchal",
    "permanentCertificate": "1234-5678-9101",
    "economicActivity": {
        "section": "K",
        "code": 668
    },
    "availableMethods": [
        {
            "code": "CC"
        },
        {
            "code": "MB"
        },
        {
            "code": "MW"
        }
    ],
    "user": {
        "name": "John Doe",
        "taxNumber": "123456789",
        "email": "email@email.email",
        "phoneNumber": "960000000",
        "isPoliticallyExposedPerson": true
    }
}

The complete data structure, as well as the options for economicActivity and availableMethods can be consulted .