Pular para o conteúdo principal
API docs by Redocly

API Palenca (1.0)

Página Nesta listamos todos os métodos na API Palenca, BEM como uma referencia completa dois parâmetros que cada um aceita. OS Terminatários da API São agrupados por recursos, Urls Têm previam, como respostas formatadas em JSON e usamos resposta http padrão, autenticação e códigos de verbos.

sandbox: https://sandbox.palenca.com/v1

produçã: https://api.palenca.com/v1

antes da admissão, recomendamos que o você familiarize com ou Entidades que gerenciamos EM Palenca (usuários, contas, logins)

Users

Create User

Registre a UM Novo Usuário em Palenca. UM USPRIDE uma economia formal ou sho* tamborador.

header Parameters
x-api-key
string

Chaver particular exclusivo da Organização. Permite solicitar os ambientes Sejam Feitos EM da Sandbox E Produce.

Request Body schema: application/json
widget_id
required
string <uuid>

obrigatório: Id do Widget ao qual o usuário estará associado

external_id
string

opcional: Identificador exclusivo externo do cliente (fornecido pelo seu próprio aplicativo)

Responses

Request samples

Content type
application/json
{
  • "widget_id": "2b0956a2-58e7-4e97-804d-2852d40f05d7",
  • "external_id": "1234567890"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "mistake": { }
}

Retrieve User

Retorna o usuário correspondente ao ID especificado

path Parameters
required
User Id (string) or User Id (string)

ID do usuário para obter

header Parameters
x-api-key
string

Chave privada exclusiva por organização. Permite que os pedidos sejam feitos em ambientes de sandbox e produção.

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "error": null,
  • "data": {
    }
}

Delete User

Elimina o usuário correspondente ao ID especificado

path Parameters
user_id
required
string <uuid>

ID do usuário para eliminar

header Parameters
x-api-key
string

Chave privada exclusiva por organização. Ele permite solicitações na caixa de areia e nos ambientes de produção.

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "error": null,
  • "data": null
}

Recuperar Contas de Usuário

Retorna as contas de usuário correspondentes ao ID de usuário especificado.

path Parameters
required
User Id (string) or User Id (string)

ID do usuário a ser obtido

header Parameters
x-api-key
string

Chave privada exclusiva por organização. Ele permite solicitações na caixa de areia e nos ambientes de produção.

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "error": null,
  • "data": {
    }
}

List Users

Retorna uma lista pagina com usuários criados entre uma variedade de datas.

header Parameters
x-api-key
string

Chave privada exclusiva por organização. Ele permite solicitações na caixa de areia e nos ambientes de produção.

Request Body schema: application/json
start_date
required
string

obrigatório: Início da data de pesquisa de formato YYYY-MM-DD

end_date
required
string

obrigatório: Data de término da pesquisa no formato YYYY-MM-DD

object
Default: {"items_per_page":100,"page":1}

opcional: Opções de paginação

Responses

Request samples

Content type
application/json
{
  • "start_date": "string",
  • "end_date": "string",
  • "options": {
    }
}

Response samples

Content type
application/json
{
  • "success": true,
  • "error": null,
  • "data": {
    },
  • "pagination": {
    }
}

Create User And Account

Registre um usuário junto com sua conta correspondente em uma única solicitação. Um usuário representa um trabalhador formal ou da economia gig e uma conta representa uma conta do trabalhador em uma plataforma específica . Atualmente disponível para IMSS e ISSSTE. Se você quiser usar este endpoint para criar contas gig economy, entre em contato conosco pelo e-mail support@palenca.com

header Parameters
x-api-key
string

Chave privada exclusiva por organização. Permite que os pedidos sejam feitos em ambientes de sandbox e produção.

Request Body schema: application/json
widget_id
string <uuid>

opcional: Id do Widget ao qual o usuário estará associado

external_id
string

opcional: Identificador exclusivo externo do cliente (fornecido pelo seu próprio aplicativo)

country
required
any
Value: "mx"

obrigatório: País

platform
required
any
Enum: "imss" "issste"

obrigatório: Plataforma com a qual deseja fazer a conexão.

identifier
required
string

obrigatório: Identificador do usuário (CURP).

Responses

Request samples

Content type
application/json
{
  • "widget_id": "2b0956a2-58e7-4e97-804d-2852d40f05d7",
  • "external_id": "1234567890"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "error": null,
  • "data": {
    }
}

Accounts

Recuperar Contas de Usuário

Retorna as contas de usuário correspondentes ao ID de usuário especificado.

path Parameters
required
User Id (string) or User Id (string)

ID do usuário a ser obtido

header Parameters
x-api-key
string

Chave privada exclusiva por organização. Ele permite solicitações na caixa de areia e nos ambientes de produção.

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "error": null,
  • "data": {
    }
}

Create Account

Registre uma nova conta correspondente ao usuário. Uma conta representa uma conta de trabalhador em plataforma específica. Atualmente disponível para IMSS e ISSST. Se você deseja usar este terminal para criar contas de economia do show entre em contato conosco em support@palnce.com

header Parameters
x-api-key
string

Chave privada exclusiva por organização. Permite que os pedidos sejam feitos em ambientes de sandbox e produção.

Request Body schema: application/json
country
required
any
Value: "mx"

obrigatório: País

platform
required
any
Enum: "imss" "issste"

obrigatório: Plataforma com a qual deseja fazer a conexão.

identifier
required
string

obrigatório: Identificador del usuario (CURP)

user_id
required
string <uuid>

obrigatório: Id del usuario al que estará asociada la cuenta

Responses

Request samples

Content type
application/json
{
  • "country": "mx",
  • "platform": "uber",
  • "identifier": "user@example.com",
  • "identifier_type": "email",
  • "password": "s3cur3p4s5w0rd"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "error": null,
  • "data": {
    }
}

Retrieve Account

A conta correspondente ao ID especificado retorna.

path Parameters
account_id
required
string <uuid>

obrigatório: ID da conta para obter

header Parameters
x-api-key
string

Chave privada exclusiva por organização. Ele permite solicitações na caixa de areia e nos ambientes de produção.

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "error": null,
  • "data": {
    }
}

Delete Account

Elimine a conta correspondente ao ID especificado

path Parameters
account_id
required
string <uuid>

obrigatório: ID da conta para eliminar

header Parameters
x-api-key
string

Chave privada exclusiva por organização. Ele permite solicitações na caixa de areia e nos ambientes de produção.

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "error": null,
  • "data": null
}

Recuperar Usuário da Conta

Retorna o usuário associado à conta.

path Parameters
account_id
required
string <uuid>

requerido: Id da conta a ser buscada.

header Parameters
x-api-key
string

Chave privada única por organização. Permite fazer solicitações em ambientes de Sandbox e Produção.

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "error": null,
  • "data": {
    }
}

Logins

List Logins

Retorna uma lista paginada com os logins criados em um intervalo de datas.

header Parameters
x-api-key
string

Chave privada única para cada organização, permitindo solicitações tanto nos ambientes Sandbox quanto em Produção.

Request Body schema: application/json
start_date
required
string

obrigatório: Início da data de pesquisa de formato YYYY-MM-DD

end_date
required
string

obrigatório: Data de término da pesquisa no formato YYYY-MM-DD

object
Default: {"items_per_page":100,"page":1}

opcional: Opções de paginação

Responses

Request samples

Content type
application/json
{
  • "start_date": "string",
  • "end_date": "string",
  • "options": {
    }
}

Response samples

Content type
application/json
{
  • "success": true,
  • "error": null,
  • "data": {
    },
  • "pagination": {
    }
}

Profile

Retrieve Account Profile

Retorne o perfil do trabalhador, correspondendo à conta especificada por meio do id.

path Parameters
account_id
required
string <uuid>

obrigatório: ID da conta para a qual você deseja obter os dados do perfil

header Parameters
x-api-key
string

Chave privada exclusiva por organização. Ele permite solicitações na caixa de areia e nos ambientes de produção.

Responses

Response samples

Content type
application/json
Example
{
  • "success": true,
  • "error": null,
  • "data": {
    }
}

Employment Mexico

Retrieve Account Employment

Retorne os dados de emprego do trabalhadorformal (IMSS, ISSSTE), correspondendo à conta especificada por id.

path Parameters
account_id
required
string <uuid>

obrigatório: ID da conta para a qual você deseja obter os dados de emprego

header Parameters
x-api-key
string

Chave privada exclusiva por organização. Ele permite solicitações na caixa de areia e nos ambientes de produção.

Responses

Response samples

Content type
application/json
Example
{
  • "success": true,
  • "error": null,
  • "data": {
    }
}

Employment Brazil

Retrieve Account Employment History

Retorna os dados do histórico de emprego do trabalhador que pertence à conta especificada no account_id.

path Parameters
account_id
required
string <uuid>

obrigatório: ID da conta para a qual você deseja obter os dados de emprego

header Parameters
x-api-key
string

Chave privada exclusiva por organização. Ele permite solicitações na caixa de areia e nos ambientes de produção.

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "error": null,
  • "data": {
    }
}

Gig earnings

Retrieve Account Earnings

Returns a paginated list with the earnings data of the gig economy worker (Uber, Rappi, Didi, etc.), corresponding to the account specified by the id.

path Parameters
account_id
required
string <uuid>

obrigatório: ID da conta para a qual você deseja obter os lucros

header Parameters
x-api-key
string

Chave privada exclusiva por organização. Permite que os pedidos sejam feitos em ambientes de sandbox e produção.

Request Body schema: application/json
start_date
required
string

obrigatório: Data de início da pesquisa no formato YYYY-MM-DD

end_date
required
string

obrigatório: Data de término da pesquisa no formato YYYY-MM-DD

object
Default: {"items_per_page":100,"page":1}

opcional: Opciones de paginación

Responses

Request samples

Content type
application/json
{
  • "start_date": "string",
  • "end_date": "string",
  • "options": {
    }
}

Response samples

Content type
application/json
{
  • "success": true,
  • "error": null,
  • "data": {
    },
  • "pagination": {
    },
  • "account_id": "e28f45c2-b137-407c-9aed-adaac2765b36"
}

CDT earnings

Retrieve payment history of a Carteira de Trabalho account

Retorna as informações do histórico de pagamentos de um trabalhador dentro da conta da Carteira de Trabalho (CDT) especificada no account_id.

path Parameters
account_id
required
string <uuid>

obrigatório: ID da conta para a qual você deseja obter os lucros

header Parameters
x-api-key
string

Chave privada exclusiva por organização. Permite que os pedidos sejam feitos em ambientes de sandbox e produção.

Request Body schema: application/json
start_date
required
string

obrigatório: Data de início da pesquisa no formato YYYY-MM-DD

end_date
required
string

obrigatório: Data de término da pesquisa no formato YYYY-MM-DD

object
Default: {"items_per_page":100,"page":1}

opcional: Opciones de paginación

Responses

Request samples

Content type
application/json
{
  • "start_date": "string",
  • "end_date": "string",
  • "options": {
    }
}

Response samples

Content type
application/json
{
  • "success": true,
  • "error": null,
  • "data": {
    },
  • "pagination": {
    }
}

Employment insights

Retrieve Employment Insights

Returns the employment insights of the formal worker (IMSS, ISSSTE), corresponding to the account specified by the ID. Palenca insights offer a list of pre-calculated variables that help risk and data science to make decisions with a greater degree of certainty.

path Parameters
account_id
required
string <uuid>

obrigatório: ID das contas para as quais você deseja obter informações de emprego

header Parameters
x-api-key
string

Chave privada exclusiva por organização. Permite que os pedidos sejam feitos em ambientes de sandbox e produção.

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "error": null,
  • "data": {
    }
}

Gerar PDF de Tendências de Emprego

Gera um arquivo PDF detalhando as tendências de emprego para a conta especificada, associada ao IMSS e ISSSTE. Este endpoint é exclusivamente para a criação do PDF e o processo leva aproximadamente 1 minuto.

Após a geração, o PDF pode ser recuperado através da chave 'employment_files' na resposta do endpoint de emprego. Esta chave contém um array de arquivos relacionados ao histórico de emprego, incluindo o PDF recém-gerado. Para informações detalhadas sobre como acessar o PDF gerado e entender a estrutura de resposta, por favor, consulte a documentação do endpoint de emprego.

⚠ Este endpoint não está disponível no ambiente Sandbox.

path Parameters
account_id
required
string <uuid>

Obrigatório: O ID da conta para o qual o PDF das tendências de emprego será gerado.

header Parameters
x-api-key
string

Chave privada única para cada organização, permitindo solicitações tanto nos ambientes Sandbox quanto em Produção.

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "error": null,
  • "data": { }
}

Gig insights

Retrieve Gig Insights

Retorne as idéias de lucros economia do show(Uber, Rappi, Didi, etc.), correspondendo à conta especificada por ID. Os insights da Palenca oferecem uma lista de variáveis ​​pré -avaliadas que ajudam as equipes de risco e ciência de dados a tomar decisões com maior grau de certeza.

path Parameters
account_id
required
string <uuid>

obrigatório: ID da conta para a qual você deseja obter as idéias doslucros Economia do Gig)

header Parameters
x-api-key
string

Chave privada exclusiva por organização. Ele permite solicitações na caixa de areia e nos ambientes de produção.

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "error": null,
  • "data": {
    }
}

Widgets

Retrieve Widget

Retorna o widget correspondente ao ID especificado

path Parameters
widget_id
required
string <uuid>

obrigatório: Id of the Widget para obter

header Parameters
x-api-key
string

Unique private key per organization. Allows requests to be made in Sandbox and Production environments.

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "error": null,
  • "data": {
    }
}

Atualizar widget

Atualizar widget.

Request Body schema: application/json
name
string

Nome do widget

countries
Array of strings

Países a serem exibidos no widget

platforms
Array of strings

Plataformas a serem exibidas no widget

require_gov_id
boolean

Adiciona uma etapa extra para solicitar o ID do Governo (CURP, CPF, etc.) ao usuário

hide_logo
boolean

Oculta o logo no widget

hide_whatsapp
boolean

Oculta o ícone do Whatsapp no widget

hide_consent
boolean

Oculta a tela de consentimento no widget

font_family
string

Fonte para modificar o texto no widget, deve existir no Google Fonts

primary_color
string

Cor primária para modificar o widget no formato hexadecimal (#FFFFFF)

border_radius
string

Define o raio da borda para botões e campos do formulário (redondo, arredondado, quadrado)

custom_privacy_url
string

URL dos termos e condições a serem exibidos no widget

whatsapp_number
string

Número de Whatsapp para receber mensagens dos usuários

Responses

Request samples

Content type
application/json
{
  • "countries": [
    ],
  • "platforms": [
    ],
  • "require_gov_id": false
}

Response samples

Content type
application/json
{
  • "success": true,
  • "error": null,
  • "data": {
    }
}

List Widgets

Retorna uma lista de widgets registrados.

query Parameters
is_sandbox
boolean
Default: false

opcional: Environment to which the widgets to be obtained correspond

header Parameters
x-api-key
string

Unique private key per organization. Allows requests to be made in Sandbox and Production environments.

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "error": null,
  • "data": [
    ]
}

Crie um widget

Crie um novo widget.

Request Body schema: application/json
name
required
string

obrigatório: Nome do widget

countries
required
Array of strings

obrigatório: Países a serem exibidos no widget

platforms
required
Array of strings

obrigatório: Plataformas a serem exibidas no widget

is_sandbox
required
boolean

obrigatório: Ambiente do widget (sandbox ou produção)

require_gov_id
boolean

Adiciona uma etapa extra para solicitar o ID do Governo (CURP, CPF, etc.) ao usuário

Responses

Request samples

Content type
application/json
{
  • "name": "Meu widget sandbox",
  • "countries": [
    ],
  • "platforms": [
    ],
  • "is_sandbox": true,
  • "require_gov_id": false
}

Response samples

Content type
application/json
{
  • "success": true,
  • "error": null,
  • "data": {
    }
}

Webhooks

Create Webhook

Registra un nuevo webhook. Para más información puedes consultar nuestra guía

header Parameters
x-api-key
string

Deixe-o privado apenas por organização. Permite realizar solicitações nos ambientes Sandbox e Produção.

Request Body schema: application/json
url
required
string

obrigatório: webhook URL

name
string

obrigatório: Name to assign to the webhook

widget_id
required
string <uuid>

obrigatório: Widget ID to which the webhook will be associated

is_sandbox
required
boolean

obrigatório: Webhook environment (sandbox or production)

sign_request
boolean
Default: false

opcional: Parameter to define whether notifications to the webhook will be signed (hmac)

Responses

Request samples

Content type
application/json
{
  • "url": "https://domain.com/webhook",
  • "name": "My webhook",
  • "is_sandbox": true,
  • "sign_request": false,
  • "widget_id": "b679c2fb-a096-4c26-a902-245f9bce66d9"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "error": null,
  • "data": {
    }
}

List Webhooks

Returns a list of registered webhooks.

header Parameters
x-api-key
string

Unique private key per organization. Allows requests to be made in Sandbox and Production environments.

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": { },
  • "error": { }
}

Retrieve Webhook

Returns the webhook corresponding to the specified id.

path Parameters
webhook_id
required
string <uuid>

obrigatório: Id of the webhook to obtain

header Parameters
x-api-key
string

Unique private key per organization. Allows requests to be made in Sandbox and Production environments.

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "error": null,
  • "data": {
    }
}

Update Webhook

Atualiza o webhook correspondente ao ID especificado.

path Parameters
webhook_id
required
string <uuid>

obrigatório: Id of the webhook to update

header Parameters
x-api-key
string

Unique private key per organization. Allows requests to be made in Sandbox and Production environments.

Request Body schema: application/json
url
string

opcional: URL del webhook

name
string

opcional: Nombre a asignar al webhook

widget_id
string <uuid>

opcional: Widget ID al que estará asociado el webhook

is_sandbox
boolean

opcional: Entorno del webhook (sandbox o producción)

sign_request
boolean

opcional: Parámetro para definir si las notificaciones al webhook estarán firmadas (hmac)

is_active
boolean

opcional: Parámetro para activar o desactivar el webhook

Responses

Request samples

Content type
application/json
{
  • "url": "https://domain.com/webhook",
  • "name": "My webhook",
  • "is_sandbox": true,
  • "is_active": true,
  • "sign_request": false,
  • "widget_id": "b679c2fb-a096-4c26-a902-245f9bce66d9"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "error": null,
  • "data": {
    }
}

Delete Webhook

Elimine o webhook correspondente ao ID especificado.

path Parameters
webhook_id
required
string <uuid>

obrigatório: Id del webhook a eliminar

header Parameters
x-api-key
string

Deixe-o privado apenas por organização. Permite realizar solicitações nos ambientes Sandbox e Produção.

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "error": null,
  • "data": null
}

Consents

Obter Consentimentos por ID Governamental

Retorna os consentimentos correspondentes ao ID Governamental especificado.

path Parameters
gov_id
required
string

O ID Governamental para obter consentimentos.

header Parameters
x-api-key
string

Chave privada única por organização. Permite realizar solicitações nos ambientes Sandbox e Produção.

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "error": null,
  • "data": {
    }
}

Buscar Consentimentos

Permite buscar consentimentos em um intervalo de datas especificado.

header Parameters
x-api-key
string

Chave privada única por organização. Permite realizar solicitações nos ambientes Sandbox e Produção.

Request Body schema: application/json
start_date
string <date>
end_date
string <date>
object

Responses

Request samples

Content type
application/json
{
  • "start_date": "2020-08-03",
  • "end_date": "2025-07-03",
  • "options": {
    }
}

Response samples

Content type
application/json
{
  • "success": true,
  • "error": null,
  • "data": [
    ]
}