Listar endereços de uma conta

Para obter informações sobre endereços cadastrados, você pode:

  1. Listar endereços de uma conta
  2. Buscar um endereço especifico

Passos para Integrar

  1. Realizar autenticação na API.
  2. Realizar a consulta das informações.

Listar endereços de uma conta

Para obter informações sobre os diversos endereços vinculados a uma conta, envie uma requisição com o ID da conta para o endpoint correspondente.

curl --request GET \
  --url https://sandbox-apicorp.celcoin.com.br/cards/v1/accounts/{accountId}/address \
  --header 'Authorization: Bearer TOKEN' \
  --header 'User-Agent: insomnia/10.0.0' \

👍

Sucesso 200

{
	"version": "1.0.0",
	"status": 200,
	"body": [
		{
			"id": 283,
			"addressType": "RESIDENTIAL",
			"address": "Nowhere St.",
			"number": "68989",
			"complement": "Suite C",
			"neighborhood": "Faraway Creek 2",
			"city": "Smallville",
			"state": "KS",
			"country": "USA",
			"zipAddress": "012365",
			"active": true,
			"mailingAddress": false,
			"createdAt": "2024-09-25 00:00:00"
		},
		{
			"id": 284,
			"addressType": "RESIDENTIAL",
			"address": "Rua Ex-Combatente Josué Ismael de Oliveira",
			"number": "128",
			"complement": "Suite C",
			"neighborhood": "Mangabeira",
			"city": "João Pessoa",
			"state": "PB",
			"country": "BRA",
			"zipAddress": "58057325",
			"active": true,
			"mailingAddress": false,
			"createdAt": "2024-09-25 12:31:38"
		},
		{
			"id": 285,
			"addressType": "RESIDENTIAL",
			"address": "Rua Ex-Combatente Josué Ismael de Oliveira",
			"number": "128",
			"complement": "Suite C",
			"neighborhood": "Mangabeira",
			"city": "João Pessoa",
			"state": "PB",
			"country": "BRA",
			"zipAddress": "58057325",
			"active": true,
			"mailingAddress": true,
			"createdAt": "2024-09-25 12:32:24"
		},
		{
			"id": 287,
			"addressType": "RESIDENTIAL",
			"address": "Rua Ex-Combatente Josué Ismael de Oliveira",
			"number": "128",
			"complement": "Suite C",
			"neighborhood": "Mangabeira",
			"city": "João Pessoa",
			"state": "PB",
			"country": "BRA",
			"zipAddress": "58057325",
			"active": true,
			"mailingAddress": false,
			"createdAt": "2024-09-26 11:35:29"
		},
		{
			"id": 288,
			"addressType": "RESIDENTIAL",
			"address": "Rua Ex-Combatente Josué Ismael de Oliveira",
			"number": "128",
			"complement": "Suite C",
			"neighborhood": "Mangabeira",
			"city": "João Pessoa",
			"state": "PB",
			"country": "BRA",
			"zipAddress": "58057325",
			"active": true,
			"mailingAddress": false,
			"createdAt": "2024-09-26 11:41:18"
		}
	]
}
CampoTipoDescrição
idintId do endereço gerado na criação da conta ou criação do endereço
addressTypecharIndica o Logradouro do endereço, R - Rua, A - Avenida
addressstring (50)Nome da rua ou avenida
numberstring (10)Numero do endereço
neighborhoodstring (20)Bairro em que se encontra o endereço
citystring (20)Cidade em que se encontra o endereço
statestring (2)Estado em que se encontra o endereço
countrystring (3)Pais em que se encontra o endereço
zipCodestring (10)Código de Endereçamento Postal
mailingAddressbooleanIndica se é o endereço de correspondência (entrega dos cartões). TRUE para indicar que é o endereço de correspondência ou FALSE para indicar que não é um endereço de correspondência
complementstring (30)Complemento do endereço
createdAtstring (50)Data em que foi cadastrado este endereço
activebooleanSe este endereço permanece ativo ou ou não

Buscar um endereço em específico

Para obter informações de um endereço específico, envie uma requisição com o ID do endereço para o endpoint correspondente.

curl --request GET \
  --url https://sandbox-apicorp.celcoin.com.br/cards/v1/accounts/{accountId}/address/{addressId} \
  --header 'Authorization: Bearer {TOKEN}' \
  --header 'User-Agent: insomnia/10.0.0' \

👍

Sucesso 200

{
	"version": "1.0.0",
	"status": 200,
	"body": {
		"id": 283,
		"addressType": "RESIDENTIAL",
		"address": "Nowhere St.",
		"number": "68989",
		"complement": "Suite C",
		"neighborhood": "Faraway Creek 2",
		"city": "Smallville",
		"state": "KS",
		"country": "USA",
		"zipAddress": "012365",
		"active": true,
		"mailingAddress": false,
		"createdAt": "2024-09-25 00:00:00"
	}
}
CampoTipoDescrição
idintId do endereço gerado na criação da conta ou criação do endereço
addressTypecharIndica o Logradouro do endereço, R - Rua, A - Avenida
addressstring (50)Nome da rua ou avenida
numberstring (10)Numero do local
neighborhoodstring (20)Bairro em que se encontra o endereç
citystring (20)Cidade em que se encontra o endereço.
statestring (2)Estado em que se encontra o endereço
countrystring (3)Pais em que se encontra o endereço
zipCodestring (10)Código de Endereçamento Postal
mailingAddressbooleanIndica se é o endereço que o cliente deve receber os cartões
complementstring (30)Complemento da localização
createdAtstring (50)Data em que foi cadastrado este endereço
activebooleanSe este endereço permanece ativo ou desativado