Participantes

Participantes são as organizações e pessoas que são donas de documentos e aparecem em eventos. Cadastre-os aqui para obter os valores de participantId e addressId usados ao criar um documento.

Todas as operações de leitura são restritas à credencial do chamador: registros criados pela sua credencial retornam todos os campos, enquanto registros de outros participantes retornam apenas os campos de identificação e localização, com a rua mascarada.

Participantes

Criar participante

curl -X POST "https://example.com/participants" \  -H "Authorization: string" \  -H "Content-Type: application/json" \  -d '{    "countryCode": "BR",    "name": "João da Fonseca",    "taxId": "11111111111",    "taxIdType": "CPF",    "type": "COMPANY"  }'

{  "id": "28b04f62-8fe2-4332-b854-fe8a922788b5"}

Use POST /participants para cadastrar um participante no conjunto de dados da sua credencial. A resposta retorna o participantId gerado.

Obter participante por chave

curl -X GET "https://example.com/participants?countryCode=BR&taxId=11111111111&taxIdType=CPF" \  -H "Authorization: string"

{  "businessName": "Empresa Exemplo LTDA",  "countryCode": "BR",  "email": "contato@exemplo.com.br",  "id": "28b04f62-8fe2-4332-b854-fe8a922788b5",  "mobileNumber": "+5511987654321",  "name": "Fulano de Tal",  "taxId": "11222333000144",  "taxIdType": "CPF",  "telephoneNumber": "+551133224455",  "type": "COMPANY"}

Use GET /participants para buscar um participante pela chave natural — código do país, tipo de documento e número do documento. O número do documento (taxId) trafega na query string.

Obter participante por id

curl -X GET "https://example.com/participants/string" \  -H "Authorization: string"

{  "businessName": "Empresa Exemplo LTDA",  "countryCode": "BR",  "email": "contato@exemplo.com.br",  "id": "28b04f62-8fe2-4332-b854-fe8a922788b5",  "mobileNumber": "+5511987654321",  "name": "Fulano de Tal",  "taxId": "11222333000144",  "taxIdType": "CPF",  "telephoneNumber": "+551133224455",  "type": "COMPANY"}

Use GET /participants/{id} para obter um participante pelo identificador da Carrot.

Endereços

Endereços pertencem a um participante, então toda operação de endereço é restrita a um participantId.

Criar endereço

curl -X POST "https://example.com/participants/string/addresses" \  -H "Authorization: string" \  -H "Content-Type: application/json" \  -d '{    "city": "São Paulo",    "countryCode": "BR",    "countryState": "São Paulo",    "name": "Edifício Jardins de Monet",    "number": "500",    "street": "Rua das Colinas"  }'

{  "id": "28b04f62-8fe2-4332-b854-fe8a922788b5"}

Use POST /participants/{participantId}/addresses para adicionar um endereço a um participante. A resposta retorna o addressId gerado, que pode ser referenciado como addressId ao criar um documento.

Listar endereços do participante

curl -X GET "https://example.com/participants/string/addresses" \  -H "Authorization: string"

[  {    "city": "São Paulo",    "complement": "Apto. 12",    "countryCode": "BR",    "countryState": "São Paulo",    "id": "28b04f62-8fe2-4332-b854-fe8a922788b5",    "latitude": -23.5505,    "longitude": -46.6333,    "neighborhood": "Jardins",    "number": "245",    "participantId": "28b04f62-8fe2-4332-b854-fe8a922788b5",    "street": "Rua das Colinas",    "zipCode": "01310100"  }]

Use GET /participants/{participantId}/addresses para listar os endereços de um participante. Endereços que sua credencial não criou são retornados apenas com os campos de identificação e localização e com a rua mascarada.

Para a sequência completa de onboarding, veja o Guia rápido de integrações.